From 2adb4dcfa1091070d9113d4b9a7b79fe00ef2167 Mon Sep 17 00:00:00 2001 From: "jeroen.akkerman" Date: Wed, 25 Apr 2018 15:32:52 +0200 Subject: [PATCH] Updated documentation --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1395b3e..d95891c 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,58 @@ Via [npm](https://www.npmjs.com/package/easymde). npm install easymde --save ``` -Below is the original [README](https://github.com/sparksuite/simplemde-markdown-editor/), rewrite for EasyMDE pending. +Via the UNPKG CDN. +```html + + +``` + +## How to use + +#### Loading the editor + +After installing and/or importing the module, you can load EasyMDE onto the first TextArea on the webpage. +```html + + +``` + +Alternatively you can select a specific TextArea, via Javascript. +```html + + +``` + +Or via jQuery. +```html + + +``` + +#### Editor functions + +Use EasyMDE.value() to get the content of the editor. +```html + +``` + +Use EasyMDE.value(val) to set the content of the editor. +```html + +``` + + +Below is the original [README](https://github.com/sparksuite/simplemde-markdown-editor/), rewrite for EasyMDE in progress. # SimpleMDE - Markdown Editor A drop-in JavaScript textarea replacement for writing beautiful and understandable Markdown. The WYSIWYG-esque editor allows users who may be less experienced with Markdown to use familiar toolbar buttons and shortcuts. In addition, the syntax is rendered while editing to clearly show the expected result. Headings are larger, emphasized words are italicized, links are underlined, etc. SimpleMDE is one of the first editors to feature both built-in autosaving and spell checking.