Merge remote-tracking branch 'origin/master'

dadhi · Sep 14, 2018 · f6c4453 · f6c4453
2 parents 23627e0 + e5804e5
commit f6c4453
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 ## CsToMd
 
-Visual Studio extension to generate a Markdown .md documentation file from the C# .cs file stripping the special symbol comments
+Visual Studio extension to generate a Markdown .md documentation file from the C# .cs file stripping the special symbol comments.
 
 This VSIX extension for Visual Studio 2017 contains a CustomTool File Generator, 
-which generates a markdown file from the .cs file by stripping the comments `/*md` and `md*/`
+which generates a markdown file from the .cs file by stripping the comments `/*md` and `md*/`.
 
 **The tool helps to turn your C# file with markdown comments into documentation file with runnable examples and what not.**
 
@@ -19,12 +19,12 @@ which generates a markdown file from the .cs file by stripping the comments `/*m
 
 ### How to use
 
-- Clone this repo.
-- Compile *CsToMd* project, find the *CsToMd.vsix* in output and install it. 
-- In properties of you .cs file set the property `CustomTool` to `CsToMd`. 
-- Save the .cs file with `/*md` and `md*/` commnents in it. 
+- Clone this repo, compile *CsToMd* project, find the *CsToMd.vsix* in output and install it.   
+__Or simply install__ a `vsix` extension from the [release](https://github.com/dadhi/CsToMd/releases/tag/1.0.0-preview-01).
+- In properties of your .cs file, set the `CustomTool` property to `CsToMd`.
+- Save the .cs file with `/*md` and `md*/` commnents in it (or without - it will work too). 
 - Check the generated .md file under the .cs file in Solution Explorer
 
-Play with the example project *CsToMdTest* in this repo to see how it works.
+Play with the example project [CsToMdTest](https://github.com/dadhi/CsToMd/tree/1.0.0-preview-01/CsToMdTest) in this repo to see how it works.
 
 **That's all for now.. Stay tuned ;-)**