Fix build and update readme file (#75)

* v2.7.7 * added docsify support * add lock file * add yarn lock file * fix build and update readme * update readme * docs changes
pajaydev · Mar 11, 2020 · 72f3353 · 72f3353
1 parent 5fa29d5
commit 72f3353
Show file tree

Hide file tree

Showing 6 changed files with 4,278 additions and 44 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,3 @@ npm-debug.log
 .gitcredentials
 **/credentials/
 .DS_Store
-package-lock.json
diff --git a/.npmignore b/.npmignore
@@ -7,5 +7,9 @@ demo
 .DS_Store
 .DS_Store?
 
+# Don't add docs folder # 
+###################### 
+docs
+
 /npm-debug.log
 /node_modules
diff --git a/README.md b/README.md
@@ -8,10 +8,11 @@ The intent is to simplify the request process by handling the tedious logic. It'
 [![Downloads](https://img.shields.io/npm/dt/ebay-node-api.svg)](https://img.shields.io/npm/dt/ebay-node-api.svg)
 [![Build Status](https://travis-ci.org/pajaydev/ebay-node-api.svg?branch=master)](https://travis-ci.org/ajay2507/ebay-node-api)
 
+**Documentation:** [https://pajaydev.github.io/ebay-node-api](https://pajaydev.github.io/ebay-node-api)
 
 ## 📒 Table of Contents
 
-* [Installation](# installation)
+* [Installation](#installation)
 * [Usage](#usage)
 * [Starter Guide](#starter-guide)
 * [Test](#test)

diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
-# Ebay API Node.js
+# **Ebay API Node.js**
 
 Ebay API Client for node js.
 
@@ -9,13 +9,13 @@ The intent is to simplify the request process by handling the tedious logic. It'
 [![Build Status](https://travis-ci.org/pajaydev/ebay-node-api.svg?branch=master)](https://travis-ci.org/ajay2507/ebay-node-api)
 
 
-## 🚚 Installation
+# 🚚**Installation**
 
 ```shell
 npm install ebay-node-api
 ```
 
-## ⚡️ Usage:
+# ⚡️**Usage**
 
 ```javascript
 let eBay = require('ebay-node-api')
@@ -46,7 +46,7 @@ If you using Sandbox environment, make sure to provide `env` variable in options
 - `headers` - optional(`Object`) - Add custom request headers. For reference [Header Section](https://developer.ebay.com/api-docs/static/rest-request-components.html#HTTP)
 - `countryCode` - optional(`String`) - sets the GLOBAL-ID parameter which specifies the eBay site to use for searches. [Possible IDs](https://developer.ebay.com/DevZone/merchandising/docs/Concepts/SiteIDToGlobalID.html)
 
-## API
+## **Examples**
 
 ### GetAccessToken
 
@@ -350,21 +350,21 @@ ebay.getShippingCosts({
 });
 ```
 
-## Test
+## **Test**
 All test files are present inside test folder. You can run using
 
 ```javascript
 npm run test
 ```
-## Issues:
+## **Issues**
 If you are facing any issues, you can create the issues [here](https://github.com/pajaydev/ebay-node-api/issues).
 
-## 👍 Contribution:
+## 👍 **Contribution**
 Show your ❤️ and support by giving a ⭐. Willing to share your idea or ready to contribute, check [here](https://github.com/pajaydev/ebay-node-api/blob/master/CONTRIBUTING.md)
 
-## 📝 License:
+## 📝 **License**
 MIT.
 
-## Examples:
+## Demo:
 I have mentioned the examples here
 https://github.com/pajaydev/ebay-node-api/tree/master/demo.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ebay-node-api",
-  "version": "2.8.0",
+  "version": "2.8.1",
   "description": "Ebay node api client",
   "main": "./src/index.js",
   "homepage": "https://github.com/pajaydev/ebay-node-api",