Skip to content

Commit c977ba1

Browse files
committed
update readme
1 parent 5dd321d commit c977ba1

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
aurl
22
====
33

4-
[![CircleCI](https://img.shields.io/circleci/project/github/classmethod/aurl.svg)](https://circleci.com/gh/classmethod/aurl)
4+
![Release](https://github.com/classmethod/aurl/workflows/Release/badge.svg)
55
[![License](https://img.shields.io/github/license/classmethod/aurl.svg)](https://github.com/classmethod/aurl/blob/master/LICENSE)
66

77
## Description
@@ -18,17 +18,29 @@ before making principal request. And more, you should to manage issued access t
1818

1919
## Install
2020

21-
To install, use `homebrew` or `go get`:
21+
You can install the pre-compiled binary by either following the steps.
22+
23+
### homebrew
2224

2325
```bash
24-
$ brew tap classmethod/repos
25-
$ brew install aurl
26+
brew tap classmethod/repos
27+
brew install aurl
2628
```
2729

30+
### scoop
31+
32+
TBD
33+
34+
### go install
35+
2836
```bash
29-
$ go get -d github.com/classmethod/aurl
37+
go install github.com/classmethod/aurl@latest
3038
```
3139

40+
### manually
41+
42+
Download the [pre-compiled binaries](https://github.com/classmethod/aurl/releases) from the OSS releases page.
43+
3244
## Usage
3345

3446
### Profile configuration
@@ -55,7 +67,6 @@ Section name is utilized as profile name. In each section following key setting
5567
| default\_content\_type | default content type header | (none) | (any) | no |
5668
| default\_user\_agent | default user agent header | aurl x.x.x | (any) | no |
5769

58-
5970
Implicit flow is not supported currently.
6071

6172
###### EXAMPLE
@@ -100,7 +111,6 @@ Token store file `~/.aurl/token/*.json` is used by aurl internally. Retrieved t
100111
You SHOULD NOT edit this file manually because this file is overwritten at any time curl is executed.
101112
You may lose comment and another extra data.
102113

103-
104114
### Execution
105115

106116
###### SYNOPSIS
@@ -161,7 +171,7 @@ $ aurl --no-print-body --print-headers -X OPTIONS http://api.example.com/path/to
161171
1. Fork ([https://github.com/classmethod/aurl/fork](https://github.com/classmethod/aurl/fork))
162172
1. Create a feature branch named like `feature/something_awesome_feature` from `development` branch
163173
1. Commit your changes
164-
1. Rebase your local changes against the `develop` branch
174+
1. Rebase your local changes against the `master` branch
165175
1. Run test suite with the `go test ./...` command and confirm that it passes
166176
1. Run `gofmt -s`
167177
1. Create new Pull Request
@@ -181,7 +191,10 @@ Flags:
181191
...
182192
```
183193

184-
185194
## Author
186195

187196
[Daisuke Miyamoto](https://github.com/dai0304)
197+
198+
## Maintainer
199+
200+
[Seiichi Arai](https://github.com/seiichi1101)

0 commit comments

Comments
 (0)