@crowdrz/crowdrz-js - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@crowdrz/crowdrz-js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Simplified wrapper for Social API",
@@ -5,0 +5,0 @@ "repository": "crowdrz/crowdrz-js",

README.md

@@ -1,14 +0,61 @@
-# Crowdrz JS 
+ <!-- PROJECT LOGO -->
+<p align="center">
+<!--
+  <a href="https://github.com/othneildrew/Best-README-Template">
+    <img src="images/logo.png" alt="Logo" width="80" height="80">
+  </a>
+-->
 
-![npm](https://img.shields.io/npm/v/@crowdrz/crowdrz-js) ![CircleCI](https://img.shields.io/circleci/build/github/crowdrz/crowdrz-js/master) ![NPM](https://img.shields.io/npm/l/@crowdrz/crowdrz-js)
+  <h3 align="center">Crowdrz JS</h3>
 
-Simplified wrapper for social APIs.
+  <p align="center">
+    Simplified wrapper for social APIs.
+    <br />
+    <a href="https://github.com/crowdrz/crowdrz-js"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/crowdrz/crowdrz-js/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/crowdrz/crowdrz-js/issues">Request Feature</a>
+    <br />
+    <br />
+    <img src="https://img.shields.io/npm/v/@crowdrz/crowdrz-js" alt="npm">
+    <img src="https://img.shields.io/circleci/build/github/crowdrz/crowdrz-js/master" alt="CircleCI">
+    <img alt="npm" src="https://img.shields.io/npm/dt/@crowdrz/crowdrz-js">
+    <img src="https://img.shields.io/npm/l/@crowdrz/crowdrz-js" alt="NPM">
+  </p>
+</p>
 
-## Installation
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
 
-This project uses [node](http://nodejs.org/) and [npm](https://npmjs.com/). Go check them out if you don't have them locally installed.
+* [Getting Started](#getting-started)
+  * [Prerequisites](#prerequisites)
+  * [Installation](#installation)
+* [Usage](#usage)
+* [Test](#test)
+* [Roadmap](#roadmap)
+* [Contributing](#contributing)
+* [License](#license)
 
-```bash
+## Getting Started
+
+### Prerequisites
+
+This project uses [node](http://nodejs.org/) and [npm](https://npmjs.com/).
+* npm
+```sh
+npm install npm@latest -g
+```
+
+### Installation
+
+1. Install package with [npm](https://npmjs.com/).
+```sh
 npm install --save @crowdrz/crowdrz-js
 ```
+3. include it in your code.
+```sh
+const Crowdrz = require('@crowdrz/crowdrz-js');
+```
 
@@ -31,7 +78,6 @@ ## Usage
 
-## Todo
+<!-- ROADMAP -->
+## Roadmap
 
-- ~~Write first test~~
-- Document the code
-- Add store process to core (csv, bdd, json etc...)
+See the [open issues](https://github.com/crowdrz/crowdrz-js/issues) for a list of proposed features (and known issues).
 
@@ -42,3 +88,10 @@ ## Contributing
 
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
 ## License
-MIT
+
+Distributed under the MIT License. See `LICENSE` for more information.

No alert changes

Improved metrics

Total package byte prevSize

274443

increased by3610.69%

Number of package files

15

increased by7.14%

Number of lines in readme file

96

increased by123.26%

No dependency changes