96 lines
3.4 KiB
Markdown
96 lines
3.4 KiB
Markdown
<p align="center">
|
|
<a href="http://alex-d.github.io/Trumbowyg/"><img src="banner.jpg" alt="" /></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://bundlephobia.com/result?p=trumbowyg"><img src="https://img.shields.io/bundlephobia/minzip/trumbowyg.svg?style=for-the-badge" alt="Downloads" /></a>
|
|
<a href="https://www.npmjs.com/package/trumbowyg"><img src="https://img.shields.io/npm/dm/trumbowyg.svg?color=blue&label=npm%20downloads&style=for-the-badge" alt="Downloads" /></a>
|
|
<a href="https://github.com/Alex-D/Trumbowyg/blob/develop/LICENSE"><img src="https://img.shields.io/npm/l/trumbowyg.svg?color=blue&style=for-the-badge" alt="Licence" /></a>
|
|
<br>
|
|
<a href="https://www.npmjs.com/package/trumbowyg"><img src="https://img.shields.io/npm/v/trumbowyg.svg?color=blue&style=for-the-badge" alt="Version on npm" /></a>
|
|
<a href="https://cdnjs.com/libraries/Trumbowyg"><img src="https://img.shields.io/cdnjs/v/Trumbowyg.svg?color=blue&style=for-the-badge" alt="CDNJS" /></a>
|
|
<img src="https://img.shields.io/bower/v/trumbowyg.svg?color=blue&style=for-the-badge" alt="Version on bower" />
|
|
</p>
|
|
|
|
|
|
<h2 align="center">Supporting Trumbowyg</h2>
|
|
|
|
Trumbowyg is an MIT-licensed open source project and completely free to use.
|
|
|
|
However, the amount of effort needed to maintain and develop new features for
|
|
the project is not sustainable without proper financial backing.
|
|
You can support it's ongoing development by being a backer or a sponsor:
|
|
|
|
- [Become a backer or sponsor on Patreon](https://www.patreon.com/alexandredemode)
|
|
- [One-time donation via PayPal](https://www.paypal.me/demodealexandre/20eur)
|
|
|
|
<h3 align="center">Sponsors</h3>
|
|
|
|
<h4 align="center">Gold</h4>
|
|
|
|
<p align="center">
|
|
<a href="https://avot.nl/?ref=trumbowyg">
|
|
<img src="https://cdn.rawgit.com/Alex-D/Trumbowyg/develop/sponsors/avot.svg" alt="avot®" width="200px"/>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://www.patreon.com/bePatron?c=1176005&rid=1940456">
|
|
Become a Sponsor
|
|
</a>
|
|
</p>
|
|
|
|
<h4 align="center">Silver</h4>
|
|
|
|
<p align="center">
|
|
<a href="https://socialoptic.com/?ref=trumbowyg">
|
|
<img src="https://rawcdn.githack.com/Alex-D/Trumbowyg/develop/sponsors/socialoptic.png" alt="SocialOptic" width="150px"/>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://www.patreon.com/bePatron?c=1176005&rid=1940456">
|
|
Become a Sponsor
|
|
</a>
|
|
</p>
|
|
|
|
------------------------------------
|
|
|
|
## Introduction
|
|
|
|
Trumbowyg is a simple and lightweight WYSIWYG editor, weight only 20kB minifed (8kB gzip) for faster page loading.
|
|
|
|
Visit presentation page: http://alex-d.github.io/Trumbowyg/
|
|
|
|
|
|
## Documentation
|
|
|
|
All you need to know about Trumbowyg is here: http://alex-d.github.io/Trumbowyg/documentation/ (or even [on the home](http://alex-d.github.io/Trumbowyg/#get-started))
|
|
|
|
|
|
## Contribution
|
|
|
|
You can contribute to Trumbowyg with translations in languages you know.
|
|
Thanks to `node` and `gulp`, you can improve core script, style or icons easily.
|
|
|
|
First, fork and clone the repository
|
|
|
|
```bash
|
|
cd Trumbowyg # go into the project's root directory
|
|
npm install # install development dependencies
|
|
npm run dev # watch mode
|
|
npm run build # to build the project
|
|
```
|
|
|
|
`gulp` command launch default Gulp task watcher and rebuild on the fly.
|
|
|
|
|
|
## Stay in touch
|
|
|
|
For the latest release and announcements, follow on Twitter: [@AlexandreDemode](https://twitter.com/AlexandreDemode)
|
|
|
|
|
|
## License
|
|
|
|
This project is under [MIT license](LICENSE).
|