#83 added implementations, client-libraries, #92 added getting started, added table of contents

mekarpeles · mekarpeles · commit c581144fa106 · 2015-11-23T00:21:49.000-08:00
diff --git a/README.md b/README.md
@@ -2,10 +2,28 @@
 
 [![ipfs](http://img.shields.io/irc/%23ipfs.png)](https://webchat.freenode.net/?channels=ipfs)
 
-IPFS is a distributed file system that seeks to connect all computing devices with the same system of files. In some ways, this is similar to the original aims of the Web, but IPFS is actually more similar to a single bittorrent swarm exchanging git objects.
+Welcome to IPFS (the InterPlanetary File System)! Why not [watch a video](https://www.youtube.com/watch?v=8CMxDNuuAiQ) to get started?
+
+## Overview
+
+IPFS ([curious about the name?](https://github.com/ipfs/ipfs#why-the-name-ipfs)) is a distributed file system that seeks to connect all computing devices with the same system of files. In some ways, this is similar to the original aims of the Web, but IPFS is actually more similar to a single bittorrent swarm exchanging git objects. You can read more about its origins in the paper [IPFS - Content Addressed, Versioned, P2P File System](https://github.com/ipfs/ipfs/blob/master/papers/ipfs-cap2pfs/ipfs-p2p-file-system.pdf?raw=true)
 
 IPFS could become a new major subsystem of the internet. If built right, it could complement or replace HTTP. It could complement or replace even more. It sounds crazy. It _is_ crazy.
 
+## Table of Contents (links)
+
+- [How IPFS Works](https://github.com/ipfs/ipfs#summary)
+- [Current State of IPFS](https://github.com/ipfs/ipfs#ipfs-is-a-work-in-progress) ([Security Considerations](https://github.com/ipfs/ipfs#security-issues))
+- [Get Started](https://ipfs.io/docs/getting-started) (Installation & Setup)
+- [The Specification](https://github.com/ipfs/specs)
+- [IPFS Implementations](https://github.com/ipfs/implementations)
+- [Client Libraries](https://github.com/ipfs/client-libraries)
+- [Community Projects](https://github.com/ipfs/ipfs/blob/master/project-directory.md)
+- [Roadmap](https://github.com/ipfs/pm)
+- [Contributing](https://github.com/ipfs/ipfs/blob/master/CONTRIBUTE.md)
+- [Help & Support](https://github.com/ipfs/ipfs#faq)
+
+
 #### IPFS IS A WORK IN PROGRESS
 
 Please note that IPFS is a work in progress. It is an ambitious plan to make the internet more free, open, secure, and high performance. It builds on the good ideas of numerous battle-tested distributed systems.
@@ -31,21 +49,6 @@ Lost? Searching for something? Need to submit an issue? Want to contribute? Take
 [![IPFS Talk](img/ipfs-talk.png)](https://www.youtube.com/watch?v=Fa4pckodM9g)
 
 
-## Design
-
-Please Read:
-
-- [IPFS - Content Addressed, Versioned, P2P File System](https://github.com/ipfs/ipfs/blob/master/papers/ipfs-cap2pfs/ipfs-p2p-file-system.pdf?raw=true)
-- IPFS - Toward The Permanent Web
-
-## Implementations
-
-- [github.com/ipfs/go-ipfs](https://github.com/ipfs/go-ipfs) in Go. Status: Alpha (reference)
-
-- [node-ipfs](http://github.com/jbenet/node-ipfs) in js (on hold)
-
-If you would like to start one, please post an issue in this repository so I can help you. There is at present no "perfect spec" and many protocol details are still to be decided upon.
-
 ## Summary
 
 IPFS is a protocol:
diff --git a/client-libraries.md b/client-libraries.md
@@ -0,0 +1,28 @@
+# IPFS Client Libraries
+
+For a list of IPFS implementations, please refer to *[implementations](https://github.org/ipfs/ipfs/implementations.md).
+
+| Language | Client Library |
+|----------|----------------|
+| Go | https://github.com/ipfs/go-ipfs-api
+| Java | https://github.com/ipfs/java-ipfs-api |
+| Javascript | https://github.com/ipfs/js-ipfs-api |
+| Python | https://github.com/ipfs/python-ipfs-api |
+| Scala | https://github.com/ipfs/scala-ipfs-api |
+| Haskell | https://github.com/davidar/hs-ipfs-api |
+| Swift | https://github.com/ipfs/swift-ipfs-api |
+| CommonLisp | https://github.com/WeMeetAgain/cl-ipfs-api |
+| Rust | https://github.com/rschulman/rust-ipfs-api |
+| Ruby | https://github.com/Fryie/ipfs-ruby |
+| Swift | https://github.com/NeoTeo/ipfs-osx-service |
+| PHP | https://github.com/cloutier/php-ipfs-api |
+| C/C++ | contact: [@PayasR](https://github.com/PayasR) |
+| Julia | contact: [@rened](https://github.com/rened) |
+| Lua | contact: [@seclorum](https://github.com/seclorum) |
+| Erlang | ! |
+
+ObjC
+Swift
+Scala - https://github.com/ipfs/scala-ipfs-api
+
+Want to contribute one of the above client libraries? [Tell us](https://github.com/ipfs/ipfs/issues/83) so we can help!
diff --git a/implementations.md b/implementations.md
@@ -0,0 +1,19 @@
+# IPFS Implementations
+
+For a list of IPFS API Client Libraries, please refer to *[Client Libraries](https://github.org/ipfs/ipfs/client-libraries.md)
+
+| Language | Project |
+|----------|---------|
+| Go* | https://github.com/ipfs/go-ipfs |
+| Javascript | https://github.com/ipfs/js-ipfs |
+| Python | https://github.com/ipfs/py-ipfs |
+| Haskell | https://github.com/cleichner/haskell-ipfs |
+| .net | https://github.com/wasabii/dotnet-ipfs |
+| C++ | https://github.com/subtly/cpp-ipfs |
+| Rust | https://github.com/rschulman/rust-ipfs |
+
+*reference
+
+Would you like to start your own language implementation of IPFS? Post an issue in this repository so we can help you. There is at present no "perfect spec" and many protocol details are still to be decided upon.
+
+
