Skip to content

Commit 319bec0

Browse files
committed
🎨 Added roadmap & ToC.
1 parent 4a4390c commit 319bec0

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ go-OAS Docs converts structured OAS3 (Swagger3) objects into the Open API Specif
1616
chosen route and port. It's extremely flexible and simple, so basically it can be integrated into any framework or
1717
existing project.
1818

19+
## Table of Contents
20+
21+
- [Getting Started](#getting-started)
22+
- [How to use](#how-to-use)
23+
* [Examples](#examples)
24+
- [Contact](#contact)
25+
- [The current roadmap (planned features)](#roadmap)
26+
1927
## Getting Started
2028

2129
1. Download **_docs_** by using:
@@ -111,9 +119,19 @@ above.
111119
112120
----
113121
114-
## Roadmap & Project board
122+
## Contact
123+
124+
Check out the current [Project board](https://github.com/go-oas/docs/projects/1) for more information.
125+
126+
You can join our Telegram group at: [https://t.me/go_oas](https://t.me/go_oas)
127+
128+
## Roadmap
115129
116-
Check out the current [Project board](https://github.com/go-oas/docs/projects/1) for more information about the first
117-
alpha release. _Note: Board & project are still in its early phase._
130+
| Feature (GH issues) | Description | Release |
131+
| --------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------- |
132+
| [Validation](https://github.com/go-oas/docs/issues/17) | Add validation to all structures based on OAS3.0.3 | v1.1.0 |
133+
| [CLI](https://github.com/go-oas/docs/issues/18) | Add CLI support - make it CLI friendly | v1.2.0 |
134+
| [Postman](https://github.com/go-oas/docs/issues/19) | Add postman support via PM API | v1.3.0 |
135+
| [ReDoc](https://github.com/go-oas/docs/issues/20) | Add ReDoc support as an alternative to SwaggerUI | v1.4.0 |
136+
| [E2E Auto-generation](https://github.com/go-oas/docs/issues/21) | Go tests conversion to Cypress/Katalon suites (convert mocked unit tests into e2e tests) | v1.5.0 |
118137
119-
You can join projects Telegram group at: [https://t.me/go_oas](https://t.me/go_oas)

0 commit comments

Comments
 (0)