bullie - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "bullie",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Easiest way to get stock market data using the Intrinio API",
   "main": "index.js",
   "scripts": {
-    "test": "npm test"
+    "test": "./node_modules/mocha/bin/mocha --recursive"
   },
@@ -9,0 +9,0 @@ "repository": {

README.md

@@ -1,4 +0,6 @@
-# Bullie: Stock market data NPM package
-##### This module contains tools to retrieve data from the Intrinio.com fintech marketplace data API.
+# Bullie: JS fueled Financial and Economic data
+[![npm version](https://badge.fury.io/js/bullie.svg)](https://badge.fury.io/js/bullie)
+[![npm](https://img.shields.io/npm/dt/bullie.svg)](https://www.npmjs.com/package/bullie)
 
+
 <img align="right" height="350" src="http://i.imgur.com/ZZqXmQ1.png">
@@ -8,8 +10,45 @@
 
-[Click here](http://gruntjs.com/) to get started with the Tahonta NPM package.
+[Click here](https://www.npmjs.com/package/bullie) to get started with the Bullie NPM package.
 
 ### Support / Contributing
-...
 
+Before you make an issue, please read our [Contributing] guide.
+
+You can find the grunt team in.
+
 ### Release History
-See the [CHANGELOG](CHANGELOG).
+See the [CHANGELOG](CHANGELOG)
+
+
+## Getting Started
+Right now, this package only supports the Intrinio fin tech marketplace data feeds. You can get 500 free API calls per day for free by registering for their API here.
+
+###### Step 1. Install it
+After you've completed registering on Intrinio, install the NPM package like you would any other.
+
+`npm install --save bullie`
+
+###### Step 2. Require it
+
+Require the module just like you would any other, pretty standard stuff.
+
+`const bullie = require('bullie');`
+
+###### Step 3. Add Intrinio Auth Stuff
+Set your Intrinio Username and Password, like so...
+
+`bullie.initialize.set_credentials(YOUR_USERNAME, YOUR_PASSWROD);`
+
+###### Step 4. Start Calling
+Let's start by making a really simple call to Intrinio for some Apple stock data. We'll use the U.S. Public Company data feed, where the item passed in is the stock symbol.
+
+```
+bullie.companies.companiesIdentifier("aapl").then(function(data) {
+  console.log(data)
+});
+  ```
+
+Think of `bullie` representing the module, `companies`, referring to the data category and `companiesIdentifier` referring the way your requesting the data, in this case using an "identifier" or stock ticker. There are A LOT of available data items and calls, as a result this is the pattern used while developing the NPM package to keep things more organized. Check out the rest of the documentation below to see what other data is available...
+
+###### Step 5. Profit
+You're on your own for this one...

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

32198

increased by1184.84%

Number of package files

37

increased by825%

Lines of code

638

increased byInfinity%

Number of lines in readme file

54

increased by260%

No dependency changes