ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update the README

Browse Source
This commit is contained in:
Hans Pagel
2021-02-08 17:46:24 +01:00
parent d9ef464c45
commit 2bd3033207
1 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -1,18 +1,14 @@
> Don’t try this at home! Nothing here is production-ready, don’t use it anywhere.
# tiptap 2 (Preview!)
A headless and extendable rich text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror), which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
<!-- [![Version](https://img.shields.io/npm/v/tiptap.svg?label=version)](https://www.npmjs.com/package/tiptap)
[![Downloads](https://img.shields.io/npm/dm/tiptap.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
[![License](https://img.shields.io/npm/l/tiptap.svg)](https://www.npmjs.com/package/tiptap)
[![Filesize](https://img.badgesize.io/https://unpkg.com/tiptap/dist/tiptap.min.js?compression=gzip&label=size&colorB=000000)](https://www.npmjs.com/package/tiptap) -->
# tiptap 2 (Sponsors preview!)
[![Version](https://img.shields.io/npm/v/@tiptap/core.svg?label=version)](https://www.npmjs.com/package/@tiptap/core)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/core.svg)](https://npmcharts.com/compare/@tiptap/core?minimal=true)
[![License](https://img.shields.io/npm/l/@tiptap/core.svg)](https://www.npmjs.com/package/@tiptap/core)
[![Build Status](https://github.com/ueberdosis/tiptap-next/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap-next/actions)
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
A headless and extendable rich text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror), which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
## Feedback
We’re looking for your feedback to improve tiptap 2 before the first public release! Share everything that helps to make it better for everyone!
We are looking for your feedback to improve tiptap 2 before the first public release! Share everything that helps to make it better for everyone!
* Create issues on GitHub! [Link](https://github.com/ueberdosis/tiptap-next/issues)
* Send an email! [humans@tiptap.dev](mailto:humans@tiptap.dev)
@@ -42,10 +38,15 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Premium Sponsors
- [überdosis](https://ueberdosis.io/)
- Jason Nelson from [mymind](https://mymind.com/)
- Gordon Mickel from [DocIQ](https://www.dociq.io/)
- [mymind](https://mymind.com/)
- [DocIQ](https://www.dociq.io/)
- [Apostrophe CMS](https://apostrophecms.com/)
- [Ycode](https://www.ycode.com/)
- [@impactvelocity](https://github.com/impactvelocity)
- [Flow Mobile](https://www.flowmobile.app/)
## Credits
- [Sam Willis](https://github.com/samwillis)
- [Christoph Flathmann](https://github.com/Chrissi2812)
- [Erick Wilder](https://github.com/erickwilder)
- [Marius Tolzmann](https://github.com/mariux)
@@ -62,13 +63,14 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
Your benefits as a sponsor:
* Give back to the open source community
* Get early access private repositories
* Get early access to private repositories
* Ensure the further maintenace and development of tiptap
* Your issues and pull requests get a `sponsor 💖` label
* Get a sponsor badge in all your comments on GitHub
* Show support in your GitHub profile
* Receive monthly reports about our open source work
Does that sound good? [Sponsor us on GitHub!](https://github.com/sponsors/ueberdosis)
Does that sound good? [Become a sponsor!](https://github.com/sponsors/ueberdosis)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.