documentation updated and test directory added to npmignore

Author: yashkathe

.npmignore

@@ -1,2 +1,3 @@
 src
+__tests_
 junk

DISCLAIMER.md

@@ -0,0 +1,44 @@
+
+<h1 align="center">Disclaimer</h1>
+
+<div align="center">
+
+<h2>This project: unoffical F1 Api</h2>
+
+<br>
+
+The core aim of this project is to co-relate automation and efficiency to extract what is provided to an user on the internet. Every content available in the project is hosted by external non-affiliated sources.
+
+<br>
+
+<b>Any content served through this project is publicly accessible. If your site is listed in this project, the code is pretty much public. Take necessary measures to counter the exploits used to extract content in your site.</b>
+
+Think of this project as your normal browser, but a bit more straight-forward and specific. While an average browser makes hundreds of requests to get everything from a site, this project goes on to make requests associated with only getting the content served by the sites.
+
+<b>
+
+This project is to be used at the user's own risk, based on their government and laws.
+
+This project has no control on the content it is serving, using copyrighted content from the providers is not going to be accounted for by the developer. It is the user's own risk.
+
+</b>
+
+<br>
+
+<h2>DMCA and Copyright Infrigements</h3>
+
+<br>
+
+<b>
+A browser is a tool, and the maliciousness of the tool is directly based on the user.  
+</b>
+
+
+<b> Do not harass the maintainer. </b>
+
+<h2>
+Contacting the maintainer
+</h2>
+<br>
+
+Begin by making a GitHub issue or sending an email to katheyash@yahoo.com

README.md

@@ -1,20 +1,56 @@
 # F1 API
-
+![f1](https://assets.stickpng.com/images/61fc01fe3cf0e70004222071.png)  
 The scraper scrapes this given https://www.formula1.com/
 
-## Functions added
+## Functions
+
+- **getConstructorStandings**  
+  
+  Fetch Constructors standings from points table.  
+  The function takes one argument: The year from which you want to extract points table for.  
+  Default argument is the current year.  
+ 
+- **getDriverStandings**   
+  Fetch F1 driver standings from points table.    
+  The function takes one argument: The year from which you want to extract points table for.      
+  Default argument is the current year. 
+
+- **getDriverData**  
+  Fetch the current lineup of F1 drivers.  
+  _No arguments_
+
+- **getTeamsData**  
+  Fetch the current list of F1 teams along with their information.  
+  _No arguments_
+  
+- **getWorldChampions**  
+  Fetch all the world champions  
+  _No arguments_
+
+## Snapshots
+
+If you want to have a look at the output from the given functions check [this](https://github.com/yashkathe/F1-API/tree/master/__tests__/__snapshots__).
+
+## Example snippet
+
+Example on how to use one the given functions.  
+The following function will print the current lineup of F1 drivers.
+
+```javascript
+const f1Api = require('f1-api') 
 
-- getDriverData  
-  Fetch the current list of F1 drivers along with their information 
+const myFunction = async () => {
+    const driverLineup = await f1Api.getDriverData()
+    console.log(driverLineup)
+}
 
-- getTeamsData  
-  Fetch the current list of F1 teams along with their information
+myFunction()
+```
 
-- getDriverStandings   
-  Fetch F1 driver standings from points table  
+## Usage
+WARNING: Abusing this library may result in an IP ban from the host website.  
+Please use with caution and try to limit the rate and amount of your requests if you value your access to formula1.com
 
-- getConstructorStandings  
-  Fetch Constructors standings from points table
+## Report Problems
 
-- getWorldChampions  
-  Fetch all the world champions 
+If you have any problems regarding this project, read the following [disclaimer](https://github.com/yashkathe/F1-API/blob/master/DISCLAIMER.md).  

package.json

@@ -10,7 +10,7 @@
         "start": "nodemon './dist/server.js'",
         "test": "jest"
     },
-    "keywords": [],
+    "keywords": ["F1" , "Formula1", "Formula1-data", "F1-API" , "Formula1-API"],
     "author": "",
     "license": "ISC",
     "devDependencies": {