diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d0fa6f --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +
+ +## ✨ Introduction + +Cue - short for MrCai's Vue - is a light-weight MVVM framework. Features include: + +- [x] Two-way binding between view and model. (Proxy + Subscriptors) +- [x] Native TypeScript support. +- [x] Handy directives, e.g. `c-bind`、`c-on`、`c-model`. + + + +## 🚀 Getting started + +`@mrcaidev/cue` is available in npm registry. + +```bash +npm i @mrcaidev/cue # npm +yarn add @mrcaidev/cue # yarn +pnpm add @mrcaidev/cue # pnpm +``` + +For detailed documentation, please refer to the [documentation](https://mrcaidev.github.io/cue/wiki). + +## 🤝 Contributing + +**Any contributions will be welcome and greatly appreciated.** + +### Bug report + +If something goes wrong, please [open an issue](https://github.com/mrcaidev/cue/issues) to help us improve. + +### Feature request + +If you have an idea of a new hook, or a better solution for an existing hook, please fork this repository and [create a pull request](https://github.com/mrcaidev/cue/pulls). + +### Other feedback + +You can always open an issue, or directly contact the author via [mrcaidev@qq.com](mailto:mrcaidev@qq.com). + +## 📜 License + +[MIT](https://github.com/mrcaidev/cue/blob/master/LICENSE) diff --git a/public/example.png b/public/example.png new file mode 100644 index 0000000..d733216 Binary files /dev/null and b/public/example.png differ diff --git a/public/logo.svg b/public/logo.svg new file mode 100644 index 0000000..a3f41d4 --- /dev/null +++ b/public/logo.svg @@ -0,0 +1,8 @@ +