index.js fixed + readme improved

Author: Nicolas

README.md

@@ -1,6 +1,6 @@
-# Linkedin client
+# Linkedin Client
 
-This service allows to fetch data about individuals or companies on [Linkedin](https://www.linkedin.com).
+This package allows to fetch data about individuals or companies on [Linkedin](https://www.linkedin.com).
 
 ![app screenshot](https://cooya.fr/images/screenshots/linkedin-company.png)
 
@@ -51,24 +51,16 @@ npm test
 Want to try running it on you own ? You will need your Linkedin cookie called "**li_at**". This way, requests will be sent on your behalf.
 
 ```bash
-git clone https://github.com/Cooya/Linkedin.git linkedin
-cd linkedin
+git clone https://github.com/Cooya/Linkedin-Client.git linkedin-client
+cd linkedin-client
 npm install
 npm run build
-touch config.js
+echo "module.exports = { cookie: 'YOUR_LINKEDIN_COOKIE' };" > config.js
 npm start
 ```
 
-Complete the configuration file "config.js" as follows :
-
-```js
-module.exports = {
- cookie: 'YOUR_LINKEDIN_COOKIE'
-};
-```
-
 ## Context
 
 - Folder _src/v1_ : At the very beginning, the project was a freelance mission for a client needing some leads. I used Linkedin API v1.
-- Folder _src/v2_ : After that I decided to design a web interface to showcase the tool, which might be useful for other people. I was limited by the Linkedin API, so I somehow completed it by retrieving data with [Puppeteer](https://github.com/puppeteer/puppeteer), a driver for an headless Google Chrome browser.
+- Folder _src/v2_ : After that I decided to design a web interface to showcase the tool. I was limited by the Linkedin API, so I somehow completed it by retrieving data with [Puppeteer](https://github.com/puppeteer/puppeteer), a driver for an headless Google Chrome browser.
 - The Linkedin API v1 is now deprecated and the v2 is not really usable so, in this third version, there is no more use of the API and I completely skipped the use of web browser, it is a simple HTTP request and [Cheerio](https://github.com/cheeriojs/cheerio) does the job.

index.js

@@ -1 +1 @@
-module.exports = { get: require('./src/LinkedinClient').getCompanyOrPeopleDetails };
+module.exports = require('./src/LinkedinClient');