This repository has been archived by the owner on Dec 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
57 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
<div align="center"> | ||
<a href="https://github.com/mrcaidev/cue" target="_blank" rel="noreferrer" hrefLang="en"> | ||
<img src="public/logo.svg" alt="Logo" width="80px"/> | ||
</a> | ||
<h1>Cue</h1> | ||
<p>A minimal MVVM framework</p> | ||
</div> | ||
|
||
## ✨ 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`. | ||
|
||
![example](public/example.png) | ||
|
||
## 🚀 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) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.