Merge pull request #10 from frictionlessdata/2-cleaning-up-and-syncin…

…g-with-py-lib

2 cleaning up and syncing with py lib

.babelrc

@@ -0,0 +1,6 @@
+{
+  "presets": ["es2015"],
+  "plugins": [
+    "add-module-exports"
+  ]
+}

.eslintignore

@@ -0,0 +1 @@
+lib/schemas/*

.eslintrc

@@ -0,0 +1,6 @@
+---
+parser: babel-eslint
+extends: airbnb/base
+env:
+  node: true
+  browser: true

.gitignore

@@ -28,3 +28,6 @@ build/Release
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
+
+# Compiled ES5 files
+lib/

.npmignore

@@ -0,0 +1,8 @@
+# Source ES6 files
+src/
+
+# Coverage directory used by tools like istanbul
+coverage/
+
+# Compiled files for the browser
+dist/

.travis.yml

@@ -1,12 +1,14 @@
 language: node_js
 node_js:
-  - "4.1.1"
+  - "4.2"
+  - "5.5"
+cache:
+  directories:
+    - node_modules
+    - .nvm
 install: npm install
 script: npm run coverage
 after_script: npm run coveralls
-branches:
-  only:
-    - master
 notifications:
   email:
     on_success: never

README.md

@@ -0,0 +1,73 @@
+# Data Package Registry
+
+[![Travis Build Status](https://travis-ci.org/okfn/datapackage-registry-js.svg?branch=master)](https://travis-ci.org/okfn/datapackage-registry-js)
+[![Coveralls](http://img.shields.io/coveralls/okfn/datapackage-registry-js.svg?branch=master)](https://coveralls.io/r/okfn/datapackage-registry-js?branch=master)
+
+JavaScript package for working with a Data Package registry.
+
+It comes with a cached version of the registry and profiles from
+https://github.com/dataprotocols/schemas.
+
+## Usage
+
+```javascript
+var Registry = require('datapackage-registry');
+
+// Without parameters, this will use the default registry (http://schemas.datapackages.org/registry.csv)
+// When using in NodeJS, this registry is locally cached, so no HTTP requests will de done.
+var registry = new Registry();
+
+// See the list of profiles available in the registry
+registry.getProfiles()
+        .then(function (profiles) {
+          console.log(profiles);
+          // {
+          //   base:
+          //    { id: 'base',
+          //      title: 'Data Package',
+          //      schema: 'http://schemas.datapackages.org/data-package.json',
+          //      schema_path: 'data-package.json',
+          //      specification: 'http://dataprotocols.org/data-packages' },
+          //   tabular:
+          //    { id: 'tabular',
+          //      title: 'Tabular Data Package',
+          //      schema: 'http://schemas.datapackages.org/tabular-data-package.json',
+          //      schema_path: 'tabular-data-package.json',
+          //      specification: 'http://dataprotocols.org/tabular-data-package/' },
+          //   fiscal:
+          //    { id: 'fiscal',
+          //      title: 'Fiscal Data Package',
+          //      schema: 'http://schemas.datapackages.org/fiscal-data-package.json',
+          //      schema_path: 'fiscal-data-package.json',
+          //      specification: 'http://fiscal.dataprotocols.org/spec/' }
+          // }
+        });
+
+// Get a profile
+registry.get('base')
+        .then(function (profile) {
+          // use profile
+        })
+        .catch(function (err) {
+          // deal with error
+        });
+```
+
+### Browser support
+
+This package requires ES6's `Promise`. If you need to support a browser that
+doesn't have it built-in (check in http://caniuse.com/#feat=promises), you have
+to use a polyfill like
+[es6-promise](https://github.com/jakearchibald/es6-promise).
+
+## Developer notes
+
+These notes are intended to help people that want to contribute to this
+package itself. If you just want to use it, you can safely ignore this.
+
+### Updating the local schemas cache
+
+We cache the schemas from <https://github.com/dataprotocols/schemas> using
+git-subtree. To update it, use:
+
+    git subtree pull --prefix schemas https://github.com/dataprotocols/schemas.git master --squash