intrinio-client - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "intrinio-client",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "NodeJS client for the Intrinio API",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # intrinio-client
-- SDK for interacting with the intrinio REST API
+- Unofficial NodeJS SDK for [Intrinio](http://www.intrinio.com)
+- The most affordable and flexible financial data on the market.
 
+## Quick Start
+
+  Create the app:
+
+```bash
+$ mkdir newApp
+$ cd newApp
+$ npm init 
+```
+
+  Install intrinio-client as a dependency:
+
+```
+$ npm install --save intrinio-client
+```
+
+  Example Use
+
 ```js
+//index.js
 var username = "" //Your Intrinio App Username
@@ -10,49 +30,111 @@ var password = "" //Your Intrinio App Password
 intrinio
-.ticker('AAPL')
+.ticker('AAPL')			//All endpoints follow this pattern
 .on('complete', function(data, response) {
+	//data is the response from the Intrinio API
+	//response is the http response
 	if(response.statusCode==404){
-		console.log("Not found ticker")
+		console.log("Not found")
 	}else if(response.statusCode==200){
-		console.log("Everything is OK with .ticker!")
+		console.log(data)
 	}
-	console.log(data)
 });
 
 ```
+* [API Endpoints](http://community.intrinio.com/docs/api/)
 
-## Installation
+```js
+//Available Endpoints
+```
+* [Prices](http://community.intrinio.com/docs/api/#Prices)
 
-```bash
-$ npm install intrinio-client
+```js
+intrinio.prices('AAPL')
+.on('complete', function(data, response) {
+
+});
 ```
 
-## Features
+* [Companies](http://community.intrinio.com/docs/api/#Companies)
 
-  * Fast, easy configuration
+```js
 
+intrinio.companies('AAPL')
+.on('complete', function(data, response) {
 
-## Docs & Community
+});
 
-  * [Website and Documentation](https://www.intrinio.com) - [[website repo](https://github.com/jspenc72/intrinio-client)]
+```
 
-## Goals
-  * 100% Intrinio End Point Coverage
+* [Securities](http://community.intrinio.com/docs/api/#Securities)
 
-## Quick Start
+```js
 
-  Create the app:
+intrinio.securities('AAPL')
+.on('complete', function(data, response) {
 
-```bash
-$ mkdir newApp
-$ cd newApp
-$ npm init 
+});
+
 ```
 
-  Install dependencies:
+* [Indices](http://community.intrinio.com/docs/api/#Indices)
 
+```js
+
+intrinio.indices('AAPL')
+.on('complete', function(data, response) {
+
+});
+
 ```
-$ npm install --save intrinio-client
+
+* [Data Point](http://community.intrinio.com/docs/api/#Data_Point)
+
+```js
+
+intrinio.data_point('AAPL')
+.on('complete', function(data, response) {
+
+});
+
 ```
 
+* [Historical Data](http://community.intrinio.com/docs/api/#Historical_Data)
 
+```js
+
+intrinio.historical_data('AAPL')
+.on('complete', function(data, response) {
+
+});
+
+```
+* [Company News](http://community.intrinio.com/docs/api/#Company_News)
+
+```js
+
+intrinio.news('AAPL')
+.on('complete', function(data, response) {
+
+});
+```
+
+## Installation
+
+```bash
+$ npm install intrinio-client
+```
+
+## Features
+
+  * Fast, easy configuration
+
+
+## Docs & Community
+
+  * [Website and Documentation](https://www.intrinio.com) - [[website repo](https://github.com/jspenc72/intrinio-client)]
+  * [NPM](https://www.npmjs.com/package/intrinio-client)
+
+## Goals
+  * 100% Intrinio End Point Coverage (Currently ~40%)
+
 ## Examples
@@ -59,0 +141,0 @@

No alert changes

Improved metrics

Total package byte prevSize

7685

increased by22.98%

Number of lines in readme file

170

increased by93.18%

No dependency changes