feat(spec): generic API spec

Author: daviddias

API/generic/README.md

@@ -0,0 +1,48 @@
+generic API
+===========
+
+#### `id`
+
+> Returns the identity of the Peer
+
+##### `Go` **WIP**
+
+##### `JavaScript` - ipfs.id([callback])
+
+`callback` must follow `function (err, identity) {}` signature, where `err` is an error if the operation was not successful. `identity` is an object with the Peer identity.
+
+If no `callback` is passed, a promise is returned.
+
+Example:
+
+```js
+ipfs.id(function (err, identity) {
+  if (err) {
+    throw err
+  }
+  console.log(identity)
+})
+```
+
+#### `version`
+
+> Returns the implementation version
+
+##### `Go` **WIP**
+
+##### `JavaScript` - ipfs.version([callback])
+
+`callback` must follow `function (err, version) {}` signature, where `err` is an error if the operation was not successful. `version` is the version string of the implementation.
+
+If no `callback` is passed, a promise is returned.
+
+Example:
+
+```js
+ipfs.version(function (err, version) {
+  if (err) {
+    throw err
+  }
+  console.log(version)
+})
+```

package.json

@@ -2,7 +2,7 @@
   "name": "interface-ipfs-core",
   "version": "0.9.0",
   "description": "A test suite and interface you can use to implement a IPFS core interface.",
-  "main": "lib/index.js",
+  "main": "src/index.js",
   "jsnext:main": "src/index.js",
   "scripts": {
     "test": "exit(0)",