Merge pull request #6 from bonsai-rx/package-dev

Publish first release

Directory.Build.props

@@ -8,14 +8,15 @@
     <ToolCommandName>bonsai.sgen</ToolCommandName>
     <PackageTags>Bonsai Rx Sgen Schema Serializer Generators</PackageTags>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <Copyright>Copyright © Bonsai Foundation CIC 2023</Copyright>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageOutputPath>..\bin\$(Configuration)</PackageOutputPath>
     <PackageProjectUrl>https://bonsai-rx.org/sgen</PackageProjectUrl>
     <RepositoryUrl>https://github.com/bonsai-rx/sgen.git</RepositoryUrl>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <VersionSuffix>build231006</VersionSuffix>
+    <VersionSuffix></VersionSuffix>
     <IncludeSymbols>true</IncludeSymbols>
     <RepositoryType>git</RepositoryType>
     <PackAsTool>true</PackAsTool>
@@ -25,5 +26,6 @@
   <ItemGroup>
     <Content Include="..\LICENSE" PackagePath="/" />
     <Content Include="..\icon.png" PackagePath="/" />
+    <Content Include="..\README.md" PackagePath="/" />
   </ItemGroup>
 </Project>

README.md

@@ -11,12 +11,16 @@ Tool for automatically generating YML serialization classes from schema files
     dotnet tool install --local Bonsai.Sgen --version 0.1.0
     ```
 
-3. Run the suggested commands in your terminal, in the root folder where you want to run the tool from:
+3. To view the tool help reference documentation, run:
 
-4. Run the tool:
+    ```cmd
+    dotnet bonsai.sgen --help
+    ```
+
+4. To generate serialization classes from a schema file:
 
     ```cmd
-    dotnet bonsai.sgen
+    dotnet bonsai.sgen --schema schema.json
     ```
 
 5. Copy the generated class file to your project `Extensions` folder.