diff --git a/README.md b/README.md index f72511e1..d7fb6816 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ Youtube2zim [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![PyPI version shields.io](https://img.shields.io/pypi/v/youtube2zim.svg)](https://pypi.org/project/youtube2zim/) +`⚠️ Disclaimer:` The main branch is currently unstable as the scraper is undergoing significant rework for the 3.0 release. If an important patch needs to be applied before the v3 release, please refer to the [v2](https://github.com/openzim/youtube/tree/v2) branch. + `youtube2zim` allows you to create a [ZIM file](https://openzim.org) from a Youtube Channel/Username or one-or-more Playlists. diff --git a/zimui/README.md b/zimui/README.md deleted file mode 100644 index c9e562ab..00000000 --- a/zimui/README.md +++ /dev/null @@ -1,45 +0,0 @@ -# zimui - -This template should help get you started developing with Vue 3 in Vite. - -## Recommended IDE Setup - -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). - -## Type Support for `.vue` Imports in TS - -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types. - -## Customize configuration - -See [Vite Configuration Reference](https://vitejs.dev/config/). - -## Project Setup - -```sh -yarn -``` - -### Compile and Hot-Reload for Development - -```sh -yarn dev -``` - -### Type-Check, Compile and Minify for Production - -```sh -yarn build -``` - -### Run Unit Tests with [Vitest](https://vitest.dev/) - -```sh -yarn test:unit -``` - -### Lint with [ESLint](https://eslint.org/) - -```sh -yarn lint -```