Skip to content

Commit 7e62398

Browse files
RichardLitthsanjuan
authored andcommitted
Standardize README
See ipfs/community#124
1 parent 6399037 commit 7e62398

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,26 @@
1-
# ipfs update
1+
# ipfs-update
2+
23
> An updater tool for ipfs. Can fetch and install given versions of go-ipfs.
34
45
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
56
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
67
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
8+
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
79

8-
![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)
9-
10-
## Installation
10+
## Install
1111

12-
Requirement: Go version 1.5 or higher
12+
Requirement: Go version 1.5 or higher.
1313

1414
```sh
1515
go get -u github.com/ipfs/ipfs-update
1616
```
1717

18-
## Note
19-
If you do not see the expected version listed by `ipfs-update versions`. Try updating
20-
`ipfs-update` (either by the above `go get` command or through gobuilder).
21-
22-
## Contribute
23-
24-
Pull requests and issues are welcome! Please open them in this repository.
25-
For more on contributing to IPFS projects, see the [contribution guidelines](https://github.com/ipfs/community/blob/master/contributing.md).
2618

2719
## Usage
2820

21+
If you do not see the expected version listed by `ipfs-update versions`. Try updating
22+
`ipfs-update` (either by the above `go get` command or through gobuilder).
23+
2924
#### version
3025

3126
`$ ipfs-update version`
@@ -60,3 +55,16 @@ back to your older stable installation.
6055
Downloads the specified version of ipfs into your current
6156
directory. This is a plumbing command that can be utilized in scripts or by
6257
more advanced users.
58+
59+
## Contribute
60+
61+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/ipfs-update/issues)!
62+
63+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
64+
65+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
66+
67+
## License
68+
69+
[MIT](LICENSE)
70+

0 commit comments

Comments
 (0)