launchlib-js - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

package.json

 {
   "name": "launchlib-js",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Unofficial Wrapper for https://launchlibrary.net",
@@ -11,3 +11,3 @@ "main": "index.js",
     "type": "git",
-    "url": "git+https://github.com/JerryFZhang/LaunchJS.git"
+    "url": "git+https://github.com/JerryFZhang/LaunchLib-js.git"
   },
@@ -17,5 +17,5 @@ "author": "JerryFZhang",
   "bugs": {
-    "url": "https://github.com/JerryFZhang/LaunchJS/issues"
+    "url": "https://github.com/JerryFZhang/LaunchLib-js/issues"
   },
-  "homepage": "https://github.com/JerryFZhang/LaunchJS#readme",
+  "homepage": "https://github.com/JerryFZhang/LaunchLib-js#readme",
   "dependencies": {
@@ -22,0 +22,0 @@ "moment": "^2.24.0",

README.md

@@ -1,2 +0,85 @@
-# LaunchJS
+# LaunchLib-js
+[![NPM version][npm-version-image]][npm-url] 
+[![NPM downloads][npm-downloads-image]][downloads-url] 
+[![MIT License][license-image]][license-url]
+
 Unofficial NPM package for wrapping Launch Library (https://launchlibrary.net)
+
+## Usage
+### Install
+`npm install --save launchlib-js`
+
+### Import
+`const Launch = require('launchlib-js')`
+
+`const LaunchLib = new Launch()`
+
+### Examples
+LaunchLib takes two parameters, a function name, and a variable, then returns the result depends on the parameters passed in.
+`LaunchLib.get(functionName, var).then(data => {...})`
+
+```
+LaunchLib.get('getLaunches', '12')
+    .then(data => { 
+        // do something
+    })
+    .catch(err => { 
+        // handle error
+    }) 
+```
+
+The above call will return next 12 upcoming launches.
+
+### Supported Request Types and Parameters
+- `getAgencyById`
+- `getAgencyByAbbr`
+- `getAgenciesByName`
+- `getAgenciesByType`
+- `getAgenciesByCountryCode`
+- `getAgencyTypeById`
+- `getAgencyTypeByName`
+- `getEventTypeById`
+- `getEventTypeByName`
+- `getLaunchById`
+- `getLaunchByName`
+- `getLaunches`
+- `getLaunchesAfter`
+- `getLaunchesBetween`
+- `getLaunchEventById`
+- `getLaunchStatusById`
+- `getLaunchStatusByName`
+- `getLocationById`
+- `getLocationByName`
+- `getLocationByCountryCode`
+- `getMissionById`
+- `getMissionByName`
+- `getMissionEventById`
+- `getMissionEventByParentId`
+- `getMissionTypeById`
+- `getMissionTypeByName`
+- `getPadById`
+- `getPadTypeByName`
+- `getPadTypeByLocationId`
+- `getRocketById`
+- `getRocketTypeByName`
+- `getRocketTypeByConfigName`
+- `getRocketEventById`
+- `getRocketEventByLaunchId`
+- `getRocketFamilyById`
+
+### Example App
+[Click here](https://github.com/JerryFZhang/rockets) to see a React + Node.js exmaple of `launchlib-js`
+
+## License
+
+Moment.js is freely distributable under the terms of the [MIT license](https://github.com/moment/moment/blob/develop/LICENSE).
+
+
+
+[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
+[license-url]: LICENSE
+
+[npm-url]: https://npmjs.org/package/launchlib-js
+[npm-version-image]: http://img.shields.io/npm/v/launchlib-js.svg?style=flat
+[npm-downloads-image]: http://img.shields.io/npm/dm/launchlib-js.svg?style=flat
+[downloads-url]: https://npmcharts.com/compare/launchlib-js?minimal=true

No alert changes

Improved metrics

Total package byte prevSize

9029

32.02%

Number of lines in readme file

85

2733.33%

No dependency changes