feat: document library usage

README.md

@@ -1,4 +1,56 @@
 # sign-teller
-Sign Teller is a library that tells one what their zodiac sign is
 
 [![Build Status](https://travis-ci.org/micah-akpan/sign-teller.svg?branch=develop)](https://travis-ci.org/micah-akpan/sign-teller) [![Coverage Status](https://coveralls.io/repos/github/micah-akpan/sign-teller/badge.svg?branch=develop)](https://coveralls.io/github/micah-akpan/sign-teller?branch=develop)
+
+
+# Project Title
+
+Sign Teller is a library that provides information about zodiac signs. It provides the user with their zodiac sign when given the user's date of birth
+
+## Getting Started
+
+To use `sign-teller` in your application as a dependency:
+- yarn add `sign-teller`
+- Require (using CommonJS or ES6 modules) it in your application
+- See the Usage section below
+
+### Prerequisites
+
+Sign Teller depends on a few pre-requisites:
+- Node >= 6
+- Yarn or npm
+
+```
+Give examples
+```
+
+### Installing
+
+A step by step series of examples that tell you how to get a development env running
+
+  - Clone the repository: `git clone https://github.com/micah-akpan/sign-teller.git`
+  - Install the dependencies by using `npm install` or if using yarn, simply use `yarn`
+  - Use the library in your application
+
+### Usage
+Tell sign is a standalone utility wrapped in a simple function and this function is also the libraries main entry point.
+Below is a demonstration of how to use this library
+```
+  const tellSign = require('sign-teller'); // if you use commonJS modules (import('sign-teller') if you use ES6 modules)
+  const dateOfBirth = '07/04/1900';
+  const signDetails = tellSign(dateOfBirth);
+  console.info(signDetails)
+```
+
+## Running the tests
+
+- Run test by using `yarn test`
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Acknowledgments
+Certain zodiac information was curated from the following sites:
+* [Horoscope](https://www.horoscope.com/zodiac-signs)
+* [Sidereal Astrology](https://thoughtcatalog.com/january-nelson/2019/01/sidereal-astrology/)

test/tell-sign.spec.js

@@ -1,5 +1,5 @@
-const tellSign = require('../lib/tell-sign');
 const assert = require('assert');
+const tellSign = require('../lib/tell-sign');
 
 describe('Library Main', () => {
   describe('tellSign', () => {