Skip to content

Commit ab92996

Browse files
committed
Added additional description of the library
1 parent e29207f commit ab92996

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

Diff for: README.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
[![API documentation](https://img.shields.io/badge/api-docs-orange.svg)](https://code-generation.nano-byte.net/)
66
A thin wrapper around the [Roslyn API](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/) to simplify generating C# code.
77

8+
This can be used to implement things like code generators for Swagger/OpenAPI Spec, ORMs, etc. using a type-safe interface rather than simple string templating.
9+
10+
While you can use the Rosyln API directly, its immutable and thread-safe design can make using it somewhat verbose and cumbersome. This library provides a simpler (but also less flexible) wrapper.
11+
812
## Usage
913

1014
Add a reference to the [`NanoByte.CodeGeneration`](https://www.nuget.org/packages/NanoByte.CodeGeneration/) NuGet package to your project. You can then generate a class like this:

Diff for: doc/main.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
A thin wrapper around the [Roslyn API](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/) to simplify generating C# code.
22

3+
This can be used to implement things like code generators for Swagger/OpenAPI Spec, ORMs, etc. using a type-safe interface rather than simple string templating.
4+
5+
While you can use the Rosyln API directly, its immutable and thread-safe design can make using it somewhat verbose and cumbersome. This library provides a simpler (but also less flexible) wrapper.
6+
37
[**GitHub repository**](https://github.com/nano-byte/code-generation)
48

59
## Usage

0 commit comments

Comments
 (0)