update readme

charlesdevandiere · Nov 18, 2019 · 2dd58f6 · 2dd58f6
1 parent 94a817f
commit 2dd58f6
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,29 @@
-# xmldoc2md
-Tool to generate markdown from C# XML documentation
+# XMLDoc2Markdown
+
+Tool to generate markdown from C# XML documentation, based on [MarkdownGenerator](https://github.com/neuecc/MarkdownGenerator) project.
+
+## How to use
+
+### Install tool
+
+```shell
+> dotnet tool install -g XMLDoc2Markdown
+```
+
+### Generate documentation
+
+```shell
+> xmldoc2md <DLL_SOURCE_PATH> <OUTPUT_DIRECTORY>
+```
+
+#### Example
+
+```shell
+> xmldoc2md Sample.dll docs
+```
+
+### Display command line help
+
+```shell
+> xmldoc2md -h
+```
diff --git a/src/XMLDoc2Markdown/XMLDoc2Markdown.csproj b/src/XMLDoc2Markdown/XMLDoc2Markdown.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.0</TargetFramework>
-    <ToolCommandName>markdown-generator</ToolCommandName> 
+    <ToolCommandName>xmldoc2md</ToolCommandName> 
     <PackAsTool>true</PackAsTool>
     <IsPackable>true</IsPackable> 
   </PropertyGroup>