Skip to content

Commit 6c133db

Browse files
committed
chore: 📝 update README.md
1 parent dddf543 commit 6c133db

File tree

1 file changed

+29
-31
lines changed

1 file changed

+29
-31
lines changed

README.md

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -21,55 +21,53 @@
2121
<img src="https://img.shields.io/github/last-commit/vueup/vue-quill?logo=github" alt="Last commit">
2222
</a>
2323
</p>
24-
25-
## Overview
24+
25+
[![Screenshot VueQuill Editor](https://user-images.githubusercontent.com/6185447/111898684-33761b00-8a5a-11eb-9458-372c0185f576.png)](https://vueup.github.io/vue-quill/#demo)
26+
27+
<p align="center">
28+
<a href="https://vueup.github.io/vue-quill/#demo" target="_blank" rel="noopener noreferrer">👀 See a Live Demo</a>
29+
</p>
30+
31+
## 🔎 Overview
2632

2733
**VueQuill** is a **Component** for building rich text editors, powered by Vue 3 and Quill.
2834

2935
- 💚 **Built With Vue 3:** More powerful and performant framework than ever before.
3036
- 🧙‍♂️ **Fully Typescript:** VueQuill source code is written entirely in TypeScript.
3137
- 🛠️ **Easy To Use:** Straightforward implementation through a simple API.
3238

33-
[👀 See a Live Demo](https://vueup.github.io/vue-quill/#demo).
34-
35-
[📘 Read the Docs to Learn More.](https://vueup.github.io/vue-quill/guide/)
39+
> 🚀 **VueQuill** is in **@beta** version! Currently the focus is on making VueQuill stable and feature complete first. Some of its features are not "finalized" and will have breaking changes over time as we discover better solutions.
3640
37-
> 🚀 **VueQuill** is in **@beta** version! Currently the focus is on making VueQuill stable and feature complete first. It is not recommended to use this for anything serious yet. Some of its features are not "finalized" and will have breaking changes over time as we discover better solutions.
41+
## 📚 Documentation
3842

39-
> 🧑‍🤝‍🧑 **VueQuill** is also contributor-driven. It is not backed by any huge company, which means that all contributions are voluntary and done by the people who need them. If you need something improved, added, or fixed, please contribute it yourself or no one will.
43+
- **[📘 Guide](https://vueup.github.io/vue-quill/guide/)**
44+
- [🚀 Introduction](https://vueup.github.io/vue-quill/guide/)
45+
- [⚙️ Installation](https://vueup.github.io/vue-quill/guide/installation.html)
46+
- [💡 Usage](https://vueup.github.io/vue-quill/guide/usage.html)
47+
- [🎨 Themes](https://vueup.github.io/vue-quill/guide/themes.html)
48+
- [🚥 Toolbar](https://vueup.github.io/vue-quill/guide/toolbar.html)
49+
- [📦 Modules](https://vueup.github.io/vue-quill/guide/modules.html)
50+
- [🛠️ Options](https://vueup.github.io/vue-quill/guide/options.html)
51+
52+
- **[🧰 APIs](https://vueup.github.io/vue-quill/api/)**
53+
- [📌 Props](https://vueup.github.io/vue-quill/api/)
54+
- [⚡ Events](https://vueup.github.io/vue-quill/api/events.html)
55+
- [📢 Methods](https://vueup.github.io/vue-quill/api/methods.html)
56+
- [🔌 Slots](https://vueup.github.io/vue-quill/api/slots.html)
57+
- [↗️ Export](https://vueup.github.io/vue-quill/api/export.html)
4058

41-
## To do list
59+
## ☑️ To do list
4260

4361
- [x] Release `alpha` version
4462
- [x] Release `beta` version
4563
- [ ] Stable `v1.0.0` release
4664
- [x] Enhance Typescript support with Vue 3
4765
- [ ] Update the Documentation with more examples and more information
4866

49-
## Demo
50-
- [See a Live Demo](https://vueup.github.io/vue-quill/#demo).
51-
52-
[![Screenshot VueQuill Editor](https://user-images.githubusercontent.com/6185447/111898684-33761b00-8a5a-11eb-9458-372c0185f576.png)](https://vueup.github.io/vue-quill/#demo)
67+
## 👏 Contributing
5368

54-
## Documentation
55-
- **[Guide](https://vueup.github.io/vue-quill/guide/)**
56-
- [Introduction](https://vueup.github.io/vue-quill/guide/)
57-
- [Installation](https://vueup.github.io/vue-quill/guide/installation.html)
58-
- [Usage](https://vueup.github.io/vue-quill/guide/usage.html)
59-
- [Themes](https://vueup.github.io/vue-quill/guide/themes.html)
60-
- [Toolbar](https://vueup.github.io/vue-quill/guide/toolbar.html)
61-
- [Modules](https://vueup.github.io/vue-quill/guide/modules.html)
62-
- [Options](https://vueup.github.io/vue-quill/guide/options.html)
63-
64-
- **[APIs](https://vueup.github.io/vue-quill/api/)**
65-
- [Props](https://vueup.github.io/vue-quill/api/)
66-
- [Events](https://vueup.github.io/vue-quill/api/events.html)
67-
- [Methods](https://vueup.github.io/vue-quill/api/methods.html)
68-
- [Slots](https://vueup.github.io/vue-quill/api/slots.html)
69-
- [Export](https://vueup.github.io/vue-quill/api/export.html)
70-
71-
## Contributing
7269
Pull requests are welcome. For major changes, please create a [new discussion](https://github.com/vueup/vue-quill/discussions) first about what you would like to change.
7370

74-
## License
71+
## 📝 License
72+
7573
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)