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

Commit

Permalink
Merge pull request #12 from ipfs/feature/add-apiary
Browse files Browse the repository at this point in the history
Added apiary file
  • Loading branch information
RichardLitt committed Dec 12, 2015
2 parents 677bb60 + 0988505 commit 0acc5e1
Show file tree
Hide file tree
Showing 6 changed files with 846 additions and 118 deletions.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License (MIT)

Copyright (c) 2015 Protocol Labs

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# IPFS API

> Official spec of the APIs that ipfs implementations must conform to, as well as test suites to ensure they do.
> IPFS HTTP API code used in doc engines
> **WARNING** This is a work in *progress*. There be dragons.
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
[![](https://img.shields.io/badge/freejs-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)

The IPFS API has two levels. The first level is a general description based on function signatures and the second one is the transport specific description.
![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)

**WARNING** This is a work in *progress*. There be dragons.

* [Level 1 Spec - Transport Agnostic](level1.md)
* Level 2 Spec - Transport Specific
* [Level 2 CLI Spec](level2/cli.md)
* [Level 2 HTTP(S) Spec](level2/http.md)
Loading

0 comments on commit 0acc5e1

Please sign in to comment.