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

update the readme description #18

Merged
merged 2 commits into from
Jan 11, 2016
Merged

update the readme description #18

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec4e435
update the readme description
daviddias Jan 10, 2016
691b1f4
add link to apiary
daviddias Jan 10, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# IPFS API
Apiary IPFS HTTP API description
================================

> IPFS HTTP API code used in doc engines
> This document holds a description of the ipfs API to be used by Apiary to create an interactive API description. (It is really cool)

[![](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/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)

![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)
[Live API](http://docs.ipfs.apiary.io/#)

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

You can find the official API spec at the specs repo on:

- https://github.com/ipfs/specs/tree/master/api

# Wanna hack on IPFS?

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