Skip to content

Commit

Permalink
📚 #9 update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardiwagner committed Jan 8, 2019
1 parent e4d64e3 commit e5814ad
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Scraper for LinkedIn full profile data, working for 2019 new website layout.
Install via npm package manager: `npm i scrapedin`

[![Build Status](https://travis-ci.org/leonardiwagner/scrapedin.svg?branch=master)](https://travis-ci.org/leonardiwagner/scrapedin) [![Coverage Status](https://coveralls.io/repos/github/leonardiwagner/scrapedin/badge.svg?branch=master)](https://coveralls.io/github/leonardiwagner/scrapedin?branch=master)

[![NPM version](https://img.shields.io/npm/v/scrapedin.svg)](https://www.npmjs.com/package/scrapedin)


#### Usage Example:
Expand Down Expand Up @@ -36,8 +36,11 @@ const profile = await profileScraper('https://www.linkedin.com/in/some-profile/'
profile: {
name, headline, location, summary, connections
},
experiences:[
{ title, company, description, date1, date2 }
positions:[
{ title, company, description, date1, date2,
roles: [
{ title, description, date1, date2 }
] }
],
educations: [
{ title, degree, date1, date2 }
Expand All @@ -48,18 +51,31 @@ const profile = await profileScraper('https://www.linkedin.com/in/some-profile/'
recommendations: [
{ user, text }
],
recommendationsCount: {
received, given
},
recommendationsReceived: [
{ user, text }
],
recommendationsGiven: [
{ user, text }
],
accomplishments: [
{ count, title, items }
],
volunteerExperience: {
title, experience, location, description, date1, date2
},
peopleAlsoViewed: [
{ user }
{ user, text }
]
}
```

### Contribution

Feel free to contribute. Just open an issue to discuss something before creating a PR.

### License

[Apache 2.0][apache-license]
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "scrapedin",
"version": "0.0.1",
"description": "linedin scraper for 2019 website",
"version": "1.0.0",
"description": "linkedin scraper for 2019 website",
"keywords": [
"linkedin",
"scraper"
Expand All @@ -20,7 +20,7 @@
"bugs": {
"url": "https://github.com/leonardiwagner/scrapedin/issues"
},
"author": "Wagner Leonardi <leonardiwagner@gmail.company>",
"author": "Wagner Leonardi <leonardiwagner@gmail.com>",
"license": "Apache-2.0",
"dependencies": {
"puppeteer": "^1.11.0",
Expand Down

0 comments on commit e5814ad

Please sign in to comment.