WIP - add extractor, generate snippet_data

node_modules/original/README.md

@@ -0,0 +1,51 @@
+# origin(al)
+
+[![Made by unshift](https://img.shields.io/badge/made%20by-unshift-00ffcc.svg?style=flat-square)](http://unshift.io)[![Version npm](http://img.shields.io/npm/v/original.svg?style=flat-square)](http://browsenpm.org/package/original)[![Build Status](http://img.shields.io/travis/unshiftio/original/master.svg?style=flat-square)](https://travis-ci.org/unshiftio/original)[![Dependencies](https://img.shields.io/david/unshiftio/original.svg?style=flat-square)](https://david-dm.org/unshiftio/original)[![Coverage Status](http://img.shields.io/coveralls/unshiftio/original/master.svg?style=flat-square)](https://coveralls.io/r/unshiftio/original?branch=master)[![IRC channel](http://img.shields.io/badge/IRC-irc.freenode.net%23unshift-00a8ff.svg?style=flat-square)](http://webchat.freenode.net/?channels=unshift)
+
+Original generates the origin URL for a given URL or URL object. In addition to
+that it also comes with a simple `same` function to check if two URL's have the
+same origin.
+
+## Install
+
+This module is browserify and node compatible and is therefor release in the npm
+registry and can be installed using:
+
+```
+npm install --save original
+```
+
+## Usage
+
+In all the examples we assume that the module is loaded using:
+
+```js
+'use strict';
+
+var origin = require('original');
+```
+
+To get the origin of a given URL simply call `origin` function with any given
+URL to get origin.
+
+```js
+var o = origin('https://google.com/foo/bar?path');
+
+// o = https://google.com
+```
+
+To compare if two URL's share the same origin you can call the `same` method.
+
+```js
+if (origin.same('https://google.com/foo', 'https://primus.io')) {
+  console.log('same');
+} else {
+  console.log('guess what, google.com and primus.io are not the same origin');
+}
+```
+
+And that's it.
+
+## License
+
+MIT