added a bit of a readme

HelloBetterLTD · Sep 23, 2017 · ee14729 · ee14729
1 parent 8702111
commit ee14729
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,9 @@
-# markdownfield
-Mark down field for SilverStripe
+# MarkdownField
+
+This module introduces a new DB field type Markdown & Markdown Editor. It uses github style Markdown style. And uses the simple markdown
+editor.
+
+https://github.com/sparksuite/simplemde-markdown-editor
+https://github.com/cebe/markdown
+
+The module is still under development, but soon will be ready, with link popups and image selectors.