Skip to content

Commit 6fb9600

Browse files
committed
Adds readme
1 parent 2203f2e commit 6fb9600

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

src/https/README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# https
2+
## Description
3+
`https` is a simple CLI for sending HTTP requests.
4+
5+
## Licensing
6+
Released under the MIT License. See the [LICENSE][] File for further details.
7+
8+
[license]: LICENSE.md
9+
10+
## Installation
11+
Install `https` as a global .NET tool using
12+
```bash
13+
dotnet tool install --global https --version 0.1.0-beta
14+
```
15+
16+
## Usage
17+
Urls without a protocol, i.e., `http://` or `https://`, by default will be assigns the `https://` protocol.
18+
19+
```bash
20+
https [method] [uri] [options] [content]
21+
```
22+
23+
For example `https put httpbin.org/put hello=world` will output:
24+
```
25+
HTTP/1.1 200 OK
26+
Connection: keep-alive
27+
Server: gunicorn/19.9.0
28+
Date: Sat, 13 Oct 2018 03:09:13 GMT
29+
Access-Control-Allow-Origin: *
30+
Access-Control-Allow-Credentials: true
31+
Via: 1.1 vegur
32+
Content-Type: application/json
33+
Content-Length: 423
34+
{
35+
"args": {},
36+
"data": "{\"hello\":\"world\"}",
37+
"files": {},
38+
"form": {},
39+
"headers": {
40+
"Connection": "close",
41+
"Content-Length": "17",
42+
"Content-Type": "application/json; charset=utf-8",
43+
"Host": "httpbin.org",
44+
"User-Agent": "dotnet-https/0.1.0.0",
45+
"X-Content": "content-x"
46+
},
47+
"json": {
48+
"hello": "world"
49+
},
50+
"origin": "50.53.112.92",
51+
"url": "https://httpbin.org/put"
52+
}
53+
```

0 commit comments

Comments
 (0)