From c255edbca36f3ae901984e5a610a53b9b9e963e1 Mon Sep 17 00:00:00 2001
From: David Dias <daviddias.p@gmail.com>
Date: Tue, 15 Sep 2015 16:50:58 +0100
Subject: [PATCH] readme till API

---
 README.md          | 58 ++++++++++++++++++++++++++++++++++++++++++++--
 package.json       | 25 ++++++++++++++++++++
 tests/base-test.js |  9 +++++++
 tests/index.js     |  6 +++++
 4 files changed, 96 insertions(+), 2 deletions(-)
 create mode 100644 package.json
 create mode 100644 tests/base-test.js
 create mode 100644 tests/index.js

diff --git a/README.md b/README.md
index 132222e..43f8dcf 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,56 @@
-# abstract-socket
-A test suite and interface you can use to implement a socket.
+abstract-connection
+===================
+
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+
+> A test suite and interface you can use to implement a connection. A connection is understood as something that offers a dial+listen interface
+
+The primary goal of this module is to enable developers to pick and swap their Record Store module as they see fit for their libp2p installation, without having to go through shims or compatibility issues. This module and test suite were heavily inspired by abstract-blob-store and abstract-stream-muxer.
+
+Publishing a test suite as a module lets multiple modules all ensure compatibility since they use the same test suite.
+
+The API is presented with both Node.js and Go primitives, however, there is not actual limitations for it to be extended for any other language, pushing forward the cross compatibility and interop through diferent stacks.
+
+
+# Modules that implement the interface
+
+- [node-libp2p-tcp](https://github.com/diasdavid/node-libp2p-tcp)
+
+# Badge
+
+Include this badge in your readme if you make a module that is compatible with the abstract-connection API. You can validate this by running the tests.
+
+![](https://raw.githubusercontent.com/diasdavid/abstract-connection/master/img/badge.svg)
+
+# How to use the battery of tests
+
+## Node.js
+
+```
+var tape = require('tape')
+var tests = require('abstract-connection/tests')
+var YourConnectionHandler = require('../src')
+
+var common = {
+  setup: function (t, cb) {
+    cb(null, YourConnectionHandler)
+  },
+  teardown: function (t, cb) {
+    cb()
+  }
+}
+
+tests(tape, common)
+```
+
+## Go
+
+> WIP
+
+# API
+
+A valid (read: that follows this abstraction) connection, must implement the following API.
+
+note: a `stream` should be a stream that implements the [abstract-stream](https://github.com/diasdavid/abstract-stream) interface.
+
+
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..5455457
--- /dev/null
+++ b/package.json
@@ -0,0 +1,25 @@
+{
+  "name": "abstract-connection",
+  "version": "0.0.0",
+  "description": "A test suite and interface you can use to implement a connection.",
+  "main": "index.js",
+  "directories": {
+    "test": "tests"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/diasdavid/abstract-connection.git"
+  },
+  "keywords": [
+    "IPFS"
+  ],
+  "author": "David Dias <daviddias@ipfs.io>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/diasdavid/abstract-connection/issues"
+  },
+  "homepage": "https://github.com/diasdavid/abstract-connection"
+}
diff --git a/tests/base-test.js b/tests/base-test.js
new file mode 100644
index 0000000..8d5f5c2
--- /dev/null
+++ b/tests/base-test.js
@@ -0,0 +1,9 @@
+module.exports.all = function (test, common) {
+  test('a test', function (t) {
+    common.setup(test, function (err, Connection) {
+      t.ifError(err)
+      t.pass('woot!')
+      t.end()
+    })
+  })
+}
diff --git a/tests/index.js b/tests/index.js
new file mode 100644
index 0000000..b232406
--- /dev/null
+++ b/tests/index.js
@@ -0,0 +1,6 @@
+var timed = require('timed-tape')
+
+module.exports = function (test, common) {
+  test = timed(test)
+  require('./base-test.js').all(test, common)
+}