Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Apr 29, 2020. It is now read-only.

Commit 9e3e0a3

Browse files
committed
Standardize README
See ipfs/community#124
1 parent a277835 commit 9e3e0a3

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
1-
Apiary IPFS HTTP API description
2-
================================
3-
4-
> Apiary IPFS HTTP API description
1+
# Apiary IPFS HTTP API description
52

63
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
74
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
85
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
6+
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
7+
8+
> Apiary IPFS HTTP API description
99
1010
[Live API](http://docs.ipfs.apiary.io/#)
1111

12-
# API spec
12+
This is the IPFS HTTP API spec, currently based on using the [go-ipfs](https://github.com/ipfs/go-ipfs) implementation. You can find the official API spec at [the specs repo](https://github.com/ipfs/specs/tree/master/public-api).
1313

14-
You can find the official API spec at the specs repo on:
14+
## Usage
1515

16-
- https://github.com/ipfs/specs/tree/master/public-api
16+
Go look at the [Live API](http://docs.ipfs.apiary.io/#), or check out the [apiary.apib](apiary.apib) source in this repository. If you would like to run the `curl` commands, please have an `ipfs daemon` running. For more on that, go to [go-ipfs](https://github.com/ipfs/go-ipfs).
1717

18-
# Want to hack on IPFS?
18+
## Contribute
19+
20+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/http-api-spec/issues)!
21+
22+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
23+
24+
### Want to hack on IPFS?
1925

2026
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
2127

28+
## License
29+
30+
MIT

0 commit comments

Comments
 (0)