Skip to content

Commit dd23ac4

Browse files
authored
Merge pull request #132 from Microsoft/preview-docs
README update for Preview release.
2 parents 4ae5fb5 + f72cfb2 commit dd23ac4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
![Category overview screenshot](docs/images/oainet.png "Microsoft + OpenAPI = Love")
22

3-
# OpenAPI.NET
3+
# OpenAPI.NET [Preview]
4+
[ Disclaimer: This repository is in a preview state. Expect to see some iterating as we work towards the final release candidate slated for early 2018. Feedback is welcome! ]
45

56
The **OpenAPI.NET** SDK contains a useful object model for OpenAPI documents in .NET along with common serializers to extract raw OAI JSON and YAML documents from the model.
67

@@ -13,12 +14,11 @@ Project Objectives
1314
- Enable developers to create Readers that translate different data formats into Open API documents.
1415

1516
# Readers
16-
The OpenAPI.NET project holds the base object model for representing OAI documents as .NET objects. Translation for different data types into this object model is handled by individual "Readers".
17+
The OpenAPI.NET project holds the base object model for representing OAI documents as .NET objects. Translation for different data types into this object model is handled by reading raw JSON/YAML or from individual "Readers", a number of which are in the works.
1718

18-
The base JSON and YAML Readers are built into this project. Below are a few other custom Readers developed externally.
19+
The base JSON and YAML Readers are built into this project. Below is the list of supported "reader" projects.
1920

20-
- EDM/OData Reader Repo: <a href="https://github.com/Microsoft/OpenAPI.NET.OData">Link</a>
21-
- .NET Comment Reader Repo: <a href="https://github.com/Microsoft/OpenAPI.NET.CSharpComment">Link</a>
21+
- .NET Comment Reader: [Coming Soon]
2222

2323
# Build Status
2424

0 commit comments

Comments
 (0)