update readme

kwinyyyc · Dec 23, 2020 · cbc0090 · cbc0090
1 parent 3d598f2
commit cbc0090
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,14 @@
-# Strapi plugin strapi-plugin-wysiwsg-react-md-editor
+# strapi-plugin-wysiwsg-react-md-editor
 
-A quick description of strapi-plugin-wysiwsg-react-md-editor.
+This is a [strapi](https://github.com/strapi/strapi) rich text editor plugin based on [react md editor](https://github.com/uiwjs/react-md-editor)
+
+![](screenshot.png)
+
+## Get started
+With yarn:
+
+   `yarn add strapi-plugin-wysiwsg-react-md-editor`
+
+   With npm:
+
+   `npm install strapi-plugin-wysiwsg-react-md-editor`
diff --git a/screenshot.png b/screenshot.png