diff --git a/Directory.Build.props b/Directory.Build.props index 6e05ba3..7dfd8a6 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -8,6 +8,7 @@ bonsai.sgen Bonsai Rx Sgen Schema Serializer Generators LICENSE + README.md Copyright © Bonsai Foundation CIC 2023 snupkg true @@ -15,7 +16,7 @@ https://bonsai-rx.org/sgen https://github.com/bonsai-rx/sgen.git true - build231006 + true git true @@ -25,5 +26,6 @@ + \ No newline at end of file diff --git a/README.md b/README.md index 29f99d2..c8e2971 100644 --- a/README.md +++ b/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.