init

README.md

@@ -0,0 +1,31 @@
+# MarkdownLivePreview
+
+This is a sublime text **3** plugin that allows you to preview your markdown insensately *in* it!
+
+### Dependencies
+
+**None**! There is no dependency! It uses [markdown2](https://github.com/trentm/python-markdown2) but it's a one file plugin, so it's included in the package.
+
+## Installation
+
+Although MarkdownLivePreview is not available on the default channel of [PackageControl](http://packagecontrol.io), you can still use it to download this little package.
+
+1. Open the command palette (`ctrl+shift+p`)
+2. Search for: `Package Control: Add Repository`
+3. Enter in the input at the bottom of ST the path to this repo: <https://github.com/math2001/MarkdownLivePreview> (tip: just drag the link in)
+4. Hit <kbd>enter</kbd>
+
+What this does is simply adding this repo to the list of packages you get when you install a package using PC.
+
+So, as you probably understood, now you just need to install MarkdownLivePreview as if it was available on the default channel:
+
+1. Open the command palette (`ctrl+shift+p`)
+2. Search for: `Package Control: Install Package`
+3. Search for: `MarkdownLivePreview`
+4. hit <kbd>enter</kbd>
+
+Done!
+
+### 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).