Skip to content

Commit ef3699d

Browse files
docs: add swagger readme
1 parent 6bbd259 commit ef3699d

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

swagger/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<p align="center">
2+
<p align="center">
3+
<img width="200px" alt="Swagger" src="https://github.com/user-attachments/assets/5d00308c-8fda-4b5b-bf39-16b10bccfe6f">
4+
5+
6+
</p>
7+
<h1 align="center"><b>Swagger Parser</b></h1>
8+
<p align="center">An API for working with Swagger Documents including: read, walk, create, mutate, and validate
9+
</p>
10+
<p align="center">
11+
<!-- Built By Speakeasy Badge -->
12+
<a href="https://speakeasy.com/"><img alt="Built by Speakeasy" src="https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg" /></a>
13+
<a href="https://github.com/speakeasy-api/openapi/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/speakeasy-api/openapi.svg?style=for-the-badge"></a>
14+
<a href="https://pkg.go.dev/github.com/speakeasy-api/openapi/swagger?tab=doc"><img alt="Go Doc" src="https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge"></a>
15+
<br />
16+
<a href="https://github.com/speakeasy-api/openapi/actions/workflows/test.yaml"><img alt="GitHub Action: Test" src="https://img.shields.io/github/actions/workflow/status/speakeasy-api/openapi/test.yaml?style=for-the-badge"></a>
17+
<a href="https://goreportcard.com/report/github.com/speakeasy-api/openapi"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/speakeasy-api/openapi?style=for-the-badge"></a>
18+
<a href="/LICENSE"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge"></a>
19+
</p>
20+
</p>
21+
22+
## Contributing
23+
24+
This repository is maintained by Speakeasy, but we welcome and encourage contributions from the community to help improve its capabilities and stability.
25+
26+
### How to Contribute
27+
28+
1. **Open Issues**: Found a bug or have a feature suggestion? Open an issue to describe what you'd like to see changed.
29+
30+
2. **Pull Requests**: We welcome pull requests! If you'd like to contribute code:
31+
- Fork the repository
32+
- Create a new branch for your feature/fix
33+
- Submit a PR with a clear description of the changes and any related issues
34+
35+
3. **Feedback**: Share your experience using the packages or suggest improvements.
36+
37+
All contributions, whether they're bug reports, feature requests, or code changes, help make this project better for everyone.
38+
39+
Please ensure your contributions adhere to our coding standards and include appropriate tests where applicable.

0 commit comments

Comments
 (0)