Update README.md

ueberdosis · Jan 18, 2024 · 6a5aa60 · 6a5aa60
1 parent abee6d5
commit 6a5aa60
Showing 1 changed file with 40 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
-# Tiptap
-A headless, framework-agnostic and extendable rich text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror).
+# Tiptap Editor
+The Tiptap open-source WYSIWYG Editor is a headless and framework-agnostic rich text editor based on [ProseMirror](https://github.com/ProseMirror/prosemirror).
+It is complemented by the collaboration open-source backend [Hocuspocus](https://github.com/ueberdosis/hocuspocus). Both the Editor and Hocuspocus form the sturdy foundation of the [Tiptap Suite](https://tiptap.dev/).
 
 [![Build Status](https://github.com/ueberdosis/tiptap/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap/actions)
 [![Version](https://img.shields.io/npm/v/@tiptap/core.svg?label=version)](https://www.npmjs.com/package/@tiptap/core)
@@ -8,38 +9,48 @@ A headless, framework-agnostic and extendable rich text editor, based on [ProseM
 [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/WtJ49jGshW)
 [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
 
-## Examples
-Have a look at the [examples to see Tiptap in action](https://tiptap.dev/examples).
+### Editor Features
+- **Out-of-the-box text editing:** Providing base editor functionality, ready for you to customize, extend and tailor to your application's needs.    
+- **Extension based:** Extensions allow you to customize your Editor experience to your liking: From basic text styling capabilities to sophisticated notion-like drag and drop block editor capabilities. Integrate any of the over 100 extensions you can find in our [documentation](https://tiptap.dev/docs/editor/extensions) or [community](https://github.com/ueberdosis/awesome-tiptap/#community-extensions).
+- **Infinitely flexible:** The editor was built to give you full freedom to define your own [extensions](https://tiptap.dev/docs/editor/guide/custom-extensions) and [nodes](https://tiptap.dev/docs/editor/api/nodes).
+
+
+### Editor Pro Extensions
+The Pro Extensions are a set of advanced functionalities that enhance the capabilities of the Tiptap Editor. They are additional features that can be integrated into the base editor to provide more sophisticated editing options.
+
+Key functionalities include collaborative editing, which allows multiple users to edit documents simultaneously, drag-and-drop file management for easier handling of documents and media, and unique node ID assignment. Review the docs right [here](https://tiptap.dev/docs/editor/extensions).
+
+Pro Extensions are free with a [Tiptap account](https://cloud.tiptap.dev/pro-extensions). Once signed up, review the guide in your account.
+
+### Make your editor collaborative
+Interested in collaborative editing? Check out our open-source package [Hocuspocus](https://github.com/ueberdosis/hocuspocus) - a collaboration backend built around the power of [Yjs](https://github.com/yjs/yjs). Hocuspocus serves as the backbone for the [Tiptap Suite](https://tiptap.dev/).
 
 ## Documentation
-The full documentation is available on [www.tiptap.dev](https://tiptap.dev/installation).
+For more detailed information, make sure to check out our [documentation](https://tiptap.dev/docs/editor/installation). If you encounter any problems or have suggestions for our system, please open an issue.
+
+### Examples & CodeSandbox
+Have a look at the [examples to see Tiptap in action](https://tiptap.dev/examples) or review and fork our codesandboxes.
+- [Basic example of the Tiptap editor.](https://codesandbox.io/p/devbox/editor-9x9dkd?embed=1&file=%2Fsrc%2FApp.js)
+- [Collaboration ready Tiptap CodeSandbox](https://codesandbox.io/p/devbox/collaboration-4stk94)
+- React notion-like block editor template: [Demo](https://templates.tiptap.dev/)
 
-## Community
+## About Tiptap
+At Tiptap we develop open-source products that also shape our paid features. We're committed to improving both, ensuring quality and reliability in every update.
+
+### Community
 For help, discussion about best practices, or any other conversation that would benefit from being searchable:
 
 [Discuss Tiptap on GitHub](https://github.com/ueberdosis/tiptap/discussions)
 
-## Sponsors 💖
+### Sponsors 💖
 <table>
   <tr>
-    <td align="center">
-      <a href="https://rimsys.io/">
-        <img src="https://unavatar.io/github/rimsys" width="100"><br>
-        <strong>Rimsys</strong>
-      </a>
-    </td>
     <td align="center">
       <a href="https://www.complish.app/">
         <img src="https://uploads-ssl.webflow.com/5fa93d27380666789a1cbbd3/5fae50824b4d2d06f3d2898f_Frame%20374.png" width="100"><br>
         <strong>Complish</strong>
       </a>
     </td>
-    <td align="center">
-      <a href="https://www.gamma.app/">
-        <img src="https://unavatar.io/gamma.app" width="100"><br>
-        <strong>Gamma</strong>
-      </a>
-    </td>
     <td align="center">
       <a href="https://www.storyblok.com/">
         <img src="https://unavatar.io/github/storyblok" width="100"><br>
@@ -52,58 +63,37 @@ For help, discussion about best practices, or any other conversation that would
         <strong>PostHog</strong>
       </a>
     </td>
-  </tr>
-</table>
-
-<table>
-  <tr>
     <td align="center" width="100">
       <a href="https://reflect.app/">
-        <img src="https://unavatar.io/reflect.app" width="50"><br>
+        <img src="https://unavatar.io/reflect.app" width="100"><br>
         <strong>Reflect</strong>
       </a>
     </td>
-    <td align="center" width="100">
-      <a href="https://bitcrowd.net/">
-        <img src="https://unavatar.io/bitcrowd.net" width="50"><br>
-        <strong>Bitcrowd</strong>
-      </a>
-    </td>
     <td align="center" width="100">
       <a href="https://ziffmedia.com/">
-        <img src="https://unavatar.io/github/ziffmedia" width="50"><br>
+        <img src="https://unavatar.io/github/ziffmedia" width="100"><br>
         <strong>Ziff Media</strong>
       </a>
     </td>
-    <td align="center" width="100">
-      <a href="https://incytestudios.com/">
-        <img src="https://unavatar.io/github/incyte" width="50"><br>
-        <strong>Incyte Studios</strong>
-      </a>
-    </td>
-    <td align="center" width="100">
-      <a href="https://dotcms.com/">
-        <img src="https://unavatar.io/github/dotcms" width="50"><br>
-        <strong>dotCMS</strong>
-      </a>
-    </td>
     <td align="center" width="100">
       <a href="https://www.basewell.com/">
-        <img src="https://unavatar.io/github/Basewell" width="50"><br>
+        <img src="https://unavatar.io/github/Basewell" width="100"><br>
         <strong>Basewell</strong>
       </a>
     </td>
   </tr>
 </table>
 
-[iFixit](https://www.ifixit.com/), [@shodgson](https://github.com/shodgson), [Markee Co.](https://markee.io/), [Makelog](https://www.makelog.com/), [Zephir](https://zephir.ch/), [IT Xpert AG](https://itxpert.ch/), [ApostropheCMS](https://apostrophecms.com/), [Novadiscovery](http://www.novadiscovery.com/), [Omics Data Automation](https://www.omicsautomation.com), [Gretel](https://github.com/gretelapp#:~:text=http%3A//www.gretel.co), [Flow Mobile](https://www.flowmobile.app/), [Ycode](https://www.ycode.com/), [DocIQ](https://www.dociq.io/) and [hundreds of awesome inviduals](https://github.com/sponsors/ueberdosis).
+<table>
+
+</table>
 
-Using Tiptap in production? Invest in the future of Tiptap and [become a sponsor!](https://github.com/sponsors/ueberdosis)
+[iFixit](https://www.ifixit.com/), [ApostropheCMS](https://apostrophecms.com/), [Novadiscovery](http://www.novadiscovery.com/), [Omics Data Automation](https://www.omicsautomation.com), [Flow Mobile](https://www.flowmobile.app/), [DocIQ](https://www.dociq.io/) and [hundreds of awesome inviduals](https://github.com/sponsors/ueberdosis).
 
-## Contributing
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+### Contributing
+Feel like adding some magic of your own to Tiptap Editor Core? We welcome contributions! Please see our [CONTRIBUTING](CONTRIBUTING.md) guidelines for how to get started.
 
-## Contributors
+### Contributors
 [Sam Willis](https://github.com/samwillis),
 [Brian Hung](https://github.com/BrianHung),
 [Dirk Holtwick](https://github.com/holtwick),