doc: improve readme.
This commit is contained in:
13
README.md
13
README.md
@ -1,17 +1,12 @@
|
|||||||
# whoami
|
# whoami
|
||||||
|
|
||||||
[](https://hub.docker.com/r/containous/whoami/)
|
[](https://hub.docker.com/r/containous/whoami/)
|
||||||
|
[](https://travis-ci.com/containous/whoami)
|
||||||
|
|
||||||
Tiny Go webserver that prints os information and HTTP request to output
|
Tiny Go webserver that prints os information and HTTP request to output
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Flags
|
|
||||||
|
|
||||||
- `cert`: give me a certificate.
|
|
||||||
- `key`: give me a key.
|
|
||||||
- `port`: give me a port number. (default: 80)
|
|
||||||
|
|
||||||
### Paths
|
### Paths
|
||||||
|
|
||||||
- `/data?size=n`: creates a response with a size `n`.
|
- `/data?size=n`: creates a response with a size `n`.
|
||||||
@ -23,6 +18,12 @@ Tiny Go webserver that prints os information and HTTP request to output
|
|||||||
- `GET`, `HEAD`, ...: returns a response with the status code defined by the `POST`
|
- `GET`, `HEAD`, ...: returns a response with the status code defined by the `POST`
|
||||||
- `POST`: changes the status code of the `GET` (`HEAD`, ...) response.
|
- `POST`: changes the status code of the `GET` (`HEAD`, ...) response.
|
||||||
|
|
||||||
|
### Flags
|
||||||
|
|
||||||
|
- `cert`: give me a certificate.
|
||||||
|
- `key`: give me a key.
|
||||||
|
- `port`: give me a port number. (default: 80)
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
```console
|
```console
|
||||||
|
Reference in New Issue
Block a user