Skip to content

Commit 340c7af

Browse files
committed
Standardize README
See ipfs/community#124
1 parent b9e1a95 commit 340c7af

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,26 @@
1-
IPFS API wrapper library written in Swift
2-
=========================================
1+
# swift-ipfs-api
32

4-
> A client library for the IPFS API.
3+
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
4+
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
5+
[![](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+
> A Swift client library for the IPFS API.
59
610
For more information about [IPFS](http://ipfs.io) or the [API commands](http://ipfs.io/docs/commands) click the links.
711

812
The Swift IPFS API shell/client is an asynchronous library that provides native calls to an IPFS node.
913

10-
## Installation
14+
## Table of Contents
15+
16+
- [Install](#install)
17+
- [Usage](#usage)
18+
- [Examples](#examples)
19+
- [Requirements](#requirements)
20+
- [Contribute](#contribute)
21+
- [License](#license)
22+
23+
## Install
1124

1225
In the root of your project:
1326

@@ -25,6 +38,7 @@ or
2538
For more information on how to install via Carthage see the [README](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application)
2639

2740
## Usage
41+
2842
Add the required frameworks to your project in Xcode:
2943

3044
- In your target's `build phases` tab.
@@ -71,5 +85,14 @@ dispatch_group_wait(group, DISPATCH_TIME_FOREVER)
7185
## Requirements
7286
Swift 2.1
7387

88+
## Contribute
89+
90+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/swift-ipfs-api/issues)!
91+
92+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
93+
94+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
95+
7496
## License
75-
MIT
97+
98+
[MIT](LICENSE)

0 commit comments

Comments
 (0)