From a28785937b4e54a2f7667d0b96faf0b4ac01e3d9 Mon Sep 17 00:00:00 2001 From: math2001 Date: Thu, 24 Nov 2016 18:25:52 +1100 Subject: [PATCH] update the readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c2c1a90..6bfe15e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MarkdownLivePreview -This is a sublime text **3** plugin that allows you to preview your markdown insensately *in* it! +This is a sublime text **3** plugin that allows you to preview your markdown instantly *in* it! ### Dependencies @@ -26,6 +26,14 @@ So, as you probably understood, now you just need to install MarkdownLivePreview Done! +### Usage + +Sometimes, you just want to open a markdown file to edit it quickly, you don't care about the preview, and even worse, **you don't want it**. So, if you want to have the preview, press `alt+m`, edit your file, and you'll get a nice preview. + +### In dev + +This plugin is not finished, there's still some things to fix (custom css, focus, etc). So, don't run away if you have any trouble, just submit an issue [here](http://github.com/math2001/MarkdownLivePreview/issues). + ### How to open the [README](http://github.com/math2001/MarkdownLivePreview/README.md) Some of the package add a command in the menus, others in the command palette, or other nowhere. None of those options are really good, especially the last one on ST3 because the packages are compressed. But, fortunately, there is plugin that exists and **will solve this problem** for us (and he has a really cute name, don't you think?): [ReadmePlease](https://packagecontrol.io/packages/ReadmePlease).