Merge pull request #5 from marcin-brzozowski/feat/update-docs

chore: update .gitignore to include 'bin/' and enhance README with fe…
marcin-brzozowski · Nov 3, 2024 · ab776a5 · ab776a5
2 parents 13a697b + 5e0aa43
commit ab776a5
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,6 +17,7 @@
 vendor/
 # binaries
 dist/
+bin/
 
 # ignore changes to launch.json
 .vscode/launch.json

diff --git a/README.md b/README.md
@@ -3,3 +3,8 @@
 ## OpenAPI Examples generation tool
 
 openapi-examples can be used to generate examples for API requests, responses or models from schema defined in OpenAPI specification document.
+
+## Features
+
+- [] Generate examples for API requests, responses or models from schema defined in OpenAPI specification document
+- [] Generate [Microcks APIExamples](https://microcks.io/schemas/APIExamples-v1alpha1-schema.json) document from OpenAPI specification document
diff --git a/bin/openapi-examples b/bin/openapi-examples
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,6 +17,7 @@ @@
     vendor/
     # binaries
     dist/
+    bin/
     # ignore changes to launch.json
     .vscode/launch.json
@@ Expand Down @@