From c37b27228b5e988ecef47ffea2ae388cd5cf795d Mon Sep 17 00:00:00 2001 From: Omid Hezaveh Date: Thu, 1 Oct 2015 19:39:38 +0300 Subject: [PATCH] Update readme to include getting started section I added a paragraph to explain getting started --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index dfdac5d..0e022f8 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,16 @@ Strapdown.js makes it embarrassingly simple to create elegant Markdown documents. No server-side compilation required. +## Getting started +You can easily use the hosted version of this JavaScript library to quickly get started. +Make an HTML file and simply add the following line before your closing HTML tag: + +Now you can open a tag like this and put your markdown inside it + + # Your markdown here + + +There's also a sample code on project's homepage. For more, please see: + http://strapdownjs.com