Add missing readme - NPM publish action requires it

Author: thetrompf

README.rst README.mdREADME.rst renamed to README.md

@@ -1,27 +1,27 @@
 embedly
--------
+=======
 
 Embedly node client library.  To find out what Embedly is all about, please
 visit http://embed.ly.
 
-News
-^^^^
+# News
+
 
 * 05/04/2016 - The callback on object creation has been removed. Initialization
 is now lazy and happens on the first API call. This is a breaking change if you
 used a callback style constructor.
 * The embedly-node modules has been updated and simplified. It is not backward
 compatible. If you want to stick with the old API, use a verion < 1.0.
 
-Prerequisites
-^^^^^^^^^^^^^
+# Prerequisites
+
 
 * nodejs - Available in most package managers
 * `npm <http://npmjs.org/>`_
 
 
-Installing
-^^^^^^^^^^
+# Installing
+
 
 To install the official latest stable version, please use npm::
 
@@ -33,11 +33,11 @@ If you would like cutting edge, then you can clone and install HEAD::
   cd embedly-node
   npm install
 
-Getting Started
-^^^^^^^^^^^^^^^
+# Getting Started
 
 Here are some examples *hint* replace xxxxxxxxxxx with real key::
 
+```js
   var EMBEDLY_KEY = 'xxxxxxxxxxxxxxxxxxxxxxxx';
 
   var embedly = require('embedly'),
@@ -89,26 +89,27 @@ Here are some examples *hint* replace xxxxxxxxxxx with real key::
     console.log('3. ');
     console.log(util.inspect(objs[0]));
   });
+```
+
+# Authentication
 
-Authentication
-^^^^^^^^^^^^^^
 
 If a key is not specified, the EMBEDLY_KEY environmental variable will be
 used. You can signup for an Embedly key at http://embed.ly. Support for
 oauth will be added in a future version of the library.
 
-Creating an api object
-^^^^^^^^^^^^^^^^^^^^^^
+# Creating an api object
+
 
 The embedly exported prototype function takes an `Object` of optional
 parameters to configure the Embedly API.
 
- :key: Your Embedly consumer key.
- :proto: The protocol to use when calling Embedly. The default is `http`.
+ `:key`: Your Embedly consumer key.
+ `:proto`: The protocol to use when calling Embedly. The default is `http`.
          `https` is also valid.
- :logger: An `Object` that has prototype functions `error` `warn` and `debug`
+ `:logger`: An `Object` that has prototype functions `error` `warn` and `debug`
           that can be invoked with a single string argument.
- :servicesRegexp: A regular expression object to match urls against before
+ `:servicesRegexp`: A regular expression object to match urls against before
                   sending to the embedly API. Urls sent to an endpoint
                   that don't match will be returned as 401 errors.
 
@@ -117,8 +118,8 @@ parameter. It is possible in certain circumstances that the embedly api
 will fail to initialize properly. Therefore it is recommended to use the
 callback function and check for errors, like the example code above.
 
-Endpoints
-^^^^^^^^^
+# Endpoints
+
 
 Embedly api endpoints are implemented as prototype functions on the api object.
 There are two endpoints implemented. See the Embedly API documentation for more
@@ -133,11 +134,12 @@ to canonize the parameters before sending them. Sending more than 20 URLs at
 a time will fail. Future version of this library will batch requests of more
 than 20 URLs into batches whose size will be configurable.
 
-Logging
-^^^^^^^
+# Logging
+
 
 `embedly-node` does provide some minimal logging to help diagnose problems. By default, a `winston` console logger with log level `error` will be created, but only if winston is installed. If you'd like more control over logging, you can create your own logger and pass it into embedly on instantiation. ex::
 
+```js
   var embedly = require('embedly'),
       winston = require('winston'),
       logger = new (winston.Logger)({
@@ -147,9 +149,10 @@ Logging
   new embedly({logger: logger}, function(err, api) {
     // do stuff with api
   });
+```
+
+# Testing
 
-Testing
-^^^^^^^
 
 We have provided some commandline tools to test the Embedly interface.
 
@@ -159,21 +162,23 @@ We have provided some commandline tools to test the Embedly interface.
 Using --help with the commands should give you a good idea of how to use them.
 
 
-Develop
-^^^^^^^
+# Develop
 
 Run tests::
 
-  npm test
+```bash
+  year test
+```
 
 Some tests will fail due to missing api key.  Set the EMBEDLY_KEY environmental
 variable with your key to get them to pass::
 
+```
   EMBEDLY_KEY=xxxxxxxxxxxxx npm test
+```
 
+# Note on Patches/Pull Requests
 
-Note on Patches/Pull Requests
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -183,7 +188,7 @@ Note on Patches/Pull Requests
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-Copyright
-^^^^^^^^^
+# Copyright
+
 
 Copyright (c) 2011 Embed.ly, Inc. See MIT-LICENSE for details.

tools/build.sh

@@ -11,7 +11,7 @@ main() {
   rm -Rf dist/
   mkdir -p dist/
   mocha
-  cp -r index.js LICENSE bin/ dist/
+  cp -r index.js LICENSE README.md bin/ dist/
 }
 
 main "$@"