From 3b50b1b2442070b5e2e93f8eccef34e2f71b8b30 Mon Sep 17 00:00:00 2001
From: PerthCharern <26418622+PerthCharern@users.noreply.github.com>
Date: Wed, 2 May 2018 14:53:29 -0700
Subject: [PATCH] More formatting changes
---
README.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index b81cd7c..536ed84 100644
--- a/README.md
+++ b/README.md
@@ -68,15 +68,15 @@ After you've correctly annotated your C# code, you'll need to build your solutio
### Simple Example Code
-Here's a simple example of how you'd use this component. The utility takes in two lists. The first shown below is the paths to your post-MSbuild.exe XML documentation files. The second is the paths to any DLLs that have classes that you reference in the C# XML comments.
+Here's a simple example. The `OpenApiGeneratorConfig` class is instantited with two lists, the document version, and the filter set version. The first list contains the paths to your Annotation XML documentation files. The second list contains the paths to the assemblies where classes referenced in the C# XML comments can be found.
-For example, if you have an annotation for a response type as follows:
+For example, if you have a C# comment for a response type as follows:
```csharp
/// Sample object retrieved
```
-You will need to include the path to the DLL file that contains the `SampleObject1` class.
+You will need to include the path to the assembly file that contains the `SampleObject1` class.
-Generating your OAI document should look something like this:
+Generating your OpenAPI.NET document should look something like this:
```csharp
var input = new OpenApiGeneratorConfig(
annotationXmlDocuments: new List()
@@ -102,7 +102,7 @@ IDictionary openApiDocuments = generator.Ge
generationDiagnostic: out result
);
```
-In this example, the generated `openApiDocuments` should contain valid OpenAPI.NET document(s) for your API based on the annotation XMLs and contract DLLs you included.
+In this example, the generated `openApiDocuments` should contain valid OpenAPI.NET document(s) for your API based on the provided annotation XMLs and contract assemblies.
### Newtonsoft (JSON.NET)
C# Document Generator supports fetching Newtonsoft.Json `JsonProperty` and `JsonIgnore` attributes. If your service contracts use Newtonsoft, you will have to include the same version of `Newtonsoft.Json.dll` as used by service contracts in the assembly paths.