File tree Expand file tree Collapse file tree 1 file changed +28
-5
lines changed Expand file tree Collapse file tree 1 file changed +28
-5
lines changed Original file line number Diff line number Diff line change 1
- IPFS API wrapper library written in Swift
2
- =========================================
1
+ # swift-ipfs-api
3
2
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.
5
9
6
10
For more information about [ IPFS] ( http://ipfs.io ) or the [ API commands] ( http://ipfs.io/docs/commands ) click the links.
7
11
8
12
The Swift IPFS API shell/client is an asynchronous library that provides native calls to an IPFS node.
9
13
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
11
24
12
25
In the root of your project:
13
26
25
38
For more information on how to install via Carthage see the [ README] ( https://github.com/Carthage/Carthage#adding-frameworks-to-an-application )
26
39
27
40
## Usage
41
+
28
42
Add the required frameworks to your project in Xcode:
29
43
30
44
- In your target's ` build phases ` tab.
@@ -71,5 +85,14 @@ dispatch_group_wait(group, DISPATCH_TIME_FOREVER)
71
85
## Requirements
72
86
Swift 2.1
73
87
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
+
74
96
## License
75
- MIT
97
+
98
+ [ MIT] ( LICENSE )
You can’t perform that action at this time.
0 commit comments