Skip to content

Commit 85d0ff4

Browse files
committed
docs: Create README.md
- Badges - Table of Contents - Installation - Usage - License
1 parent 4d77ad5 commit 85d0ff4

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# OpenAPI CLI
2+
3+
[![Go Report Card](https://goreportcard.com/badge/github.com/mertssmnoglu/openapi-cli)](https://goreportcard.com/report/github.com/mertssmnoglu/openapi-cli)
4+
[![GoDoc](https://godoc.org/github.com/mertssmnoglu/openapi-cli?status.svg)](https://godoc.org/github.com/mertssmnoglu/openapi-cli)
5+
![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)
6+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/mertssmnoglu/openapi-cli)
7+
8+
A Command Line Interface (CLI) tool for serving, validating, and linting OpenAPI specifications.
9+
10+
## Table of Contents
11+
12+
- [Installation](#installation)
13+
- [GitHub Releases](#github-releases)
14+
- [Command Line](#command-line)
15+
- [Usage](#usage)
16+
- [License](#license)
17+
18+
## Installation
19+
20+
### GitHub Releases
21+
22+
Please visit the [GitHub Releases](https://github.com/mertssmnoglu/openapi-cli/releases) page to download the latest version of the OpenAPI CLI.
23+
24+
### Command Line
25+
26+
To install the latest version of the OpenAPI CLI via the command line, you can use the following command:
27+
28+
```shell
29+
go install github.com/mertssmnoglu/openapi-cli@latest
30+
```
31+
32+
It will automatically download the latest version of the OpenAPI CLI and install it in your `$GOPATH/bin` directory. Make sure that your `$GOPATH/bin` directory is in your `$PATH`.
33+
34+
## Usage
35+
36+
```shell
37+
>>> openapi-cli help
38+
39+
A Command Line Interface (CLI) tool for serving, validating, and linting OpenAPI specifications.
40+
41+
Usage:
42+
openapi-cli [command]
43+
44+
Available Commands:
45+
completion Generate the autocompletion script for the specified shell
46+
help Help about any command
47+
serve Serve the OpenAPI file
48+
49+
Flags:
50+
-h, --help help for openapi-cli
51+
52+
Use "openapi-cli [command] --help" for more information about a command.
53+
```
54+
55+
## License
56+
57+
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)