From 7e4c2aa019bdcd0091163ae47d063f45515e5178 Mon Sep 17 00:00:00 2001 From: Jeroen Akkerman Date: Wed, 24 Jan 2018 10:58:55 +0100 Subject: [PATCH] Added section explaining the fork --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 5b0728e..299bdf0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ +# Fork of SimpleMDE +This repository is a fork of [SimpleMDE, made by Sparksuite](https://github.com/sparksuite/simplemde-markdown-editor/). + +I originally made this fork to implement FontAwesome 5 compatibility into SimpleMDE. When that was done I submitted a [pull request](https://github.com/sparksuite/simplemde-markdown-editor/pull/666), which has not been accepted yet. This, and the project being inactive since May 2017, triggered me to make more changes and try to put new life into the project. + +Changes include: +* FontAwesome 5 compatibility +* Guide button works when editor is in preview mode +* Links are now `https://` by default +* Small styling changes +* Node 8 and Node 9 support +* Lots of refactored code + +My intention is to continue development on this project, improving it and keeping it alive. + +Below is the original [README](https://github.com/sparksuite/simplemde-markdown-editor/) + # 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.