mirror of
https://github.com/LukeHagar/arbiter.git
synced 2025-12-06 04:19:14 +00:00
Update README.md
This commit is contained in:
26
README.md
26
README.md
@@ -19,32 +19,6 @@ Arbiter is a powerful API proxy and documentation generator that automatically c
|
|||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install -g arbiter
|
|
||||||
```
|
|
||||||
|
|
||||||
### Basic Usage
|
|
||||||
|
|
||||||
Start Arbiter by pointing it to your target API:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
arbiter --target https://api.example.com
|
|
||||||
```
|
|
||||||
|
|
||||||
Then send requests through the proxy:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl http://localhost:8080/users
|
|
||||||
```
|
|
||||||
|
|
||||||
And view the automatically generated documentation:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
open http://localhost:9000/docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Docker Usage
|
### Docker Usage
|
||||||
|
|
||||||
You can run Arbiter using Docker:
|
You can run Arbiter using Docker:
|
||||||
|
|||||||
Reference in New Issue
Block a user