Skip to content

Commit 66585e8

Browse files
committed
Update README file
1 parent 9c38793 commit 66585e8

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
# sgen
2-
Tool for automatically generating YML serialization classes from schema files
1+
# Serializer Generator Tool
2+
3+
Tool for automatically generating YAML / JSON serialization classes and constructor operators from schema files.
34

45
## Getting Started
56

6-
1. Navigate to the [Bonsai.Sgen toolbox NuGet package](https://www.nuget.org/packages/Bonsai.Sgen/)
7-
2. Click `NET CLI (Local)` and copy the two suggested commands. E.g.:
7+
1. Navigate to the [Bonsai.Sgen NuGet tool package](https://www.nuget.org/packages/Bonsai.Sgen/)
8+
2. Click `.NET CLI (Local)` and copy the two suggested commands. E.g.:
89

910
```cmd
1011
dotnet new tool-manifest # if you are setting up this repo
11-
dotnet tool install --local Bonsai.Sgen --version 0.1.0
12+
dotnet tool install --local Bonsai.Sgen --version 0.2.0
1213
```
1314
1415
3. To view the tool help reference documentation, run:
@@ -17,25 +18,31 @@ Tool for automatically generating YML serialization classes from schema files
1718
dotnet bonsai.sgen --help
1819
```
1920
20-
4. To generate serialization classes from a schema file:
21+
4. To generate YAML serialization classes from a schema file:
22+
23+
```cmd
24+
dotnet bonsai.sgen --schema schema.json --serializer YamlDotNet
25+
```
26+
27+
5. To generate JSON serialization classes from a schema file:
2128
2229
```cmd
23-
dotnet bonsai.sgen --schema schema.json
30+
dotnet bonsai.sgen --schema schema.json --serializer NewtonsoftJson
2431
```
2532
26-
5. Copy the generated class file to your project `Extensions` folder.
33+
6. Copy the generated class file to your project `Extensions` folder.
2734
28-
6. Add the necessary package references to your `Extensions.csproj` file. For instance:
35+
7. Add the necessary package references to your `Extensions.csproj` file. For example:
2936
3037
```xml
3138
<ItemGroup>
3239
<PackageReference Include="Bonsai.Core" Version="2.8.0" />
33-
<PackageReference Include="YamlDotNet" Version="12.0.2" />
40+
<PackageReference Include="YamlDotNet" Version="13.7.1" />
3441
</ItemGroup>
3542
</Project>
3643
```
3744
38-
7. To restore the tool at any point, run:
45+
8. To restore the tool at any point, run:
3946
4047
```cmd
4148
dotnet tool restore

0 commit comments

Comments
 (0)