From f67b3bed9a70c60b4e577b5cd11b48ff74ca9a96 Mon Sep 17 00:00:00 2001
From: mohamed ali <mohamed@ali.com>
Date: Fri, 24 Sep 2021 13:17:56 +0200
Subject: [PATCH] Readme

---
 J2dConsole/J2dConsole.csproj |  2 ++
 README.md                    | 23 ++++++++++++++++++++++-
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/J2dConsole/J2dConsole.csproj b/J2dConsole/J2dConsole.csproj
index dc85da2..c29bf2a 100644
--- a/J2dConsole/J2dConsole.csproj
+++ b/J2dConsole/J2dConsole.csproj
@@ -4,6 +4,8 @@
     <OutputType>Exe</OutputType>
     <TargetFramework>net5.0</TargetFramework>
     <AssemblyName>J2d</AssemblyName>
+    <ReleaseVersion>1.0.1</ReleaseVersion>
+    <SynchReleaseVersion>false</SynchReleaseVersion>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/README.md b/README.md
index 87ea3e6..f76cd71 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # JsonToDart
 
-A Dotnet App to create dart class from json, taking null-safety into consideration
+A Dotnet cross-platform App to create dart class from json, taking null-safety into consideration
 
 The dart class extends `Serializable` base class
 
@@ -28,3 +28,24 @@ abstract class Serializable {
 
 ```
 
+
+
+## How to use
+
+### Windows
+
+For windows the app is available as Windows Forms app, and as console app,
+
+for the console app you can provide your json input via a file, the clipboard or just write it in the console, and you can take the output dart code by any of the three ways,
+
+to run it, open the CMD, go to the app folder, and write `j2d`, you will see help text.
+
+### MacOS
+
+For MacOS the app is available as console only, with the same options available for windows console
+
+to run it, open the Terminal app, go to the app folder, write `dotnet j2d.dll`, you will see the help text
+
+### Linux
+
+it should be easy to compile the console app for linux, but it's not yet tested :)