Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 9, 2020
1 parent 5083522 commit 31fd260
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 11 deletions.
169 changes: 160 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,56 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->








[![scrape-it](https://i.imgur.com/j3Z0rbN.png)](#)











# scrape-it

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Travis](https://img.shields.io/travis/IonicaBizau/scrape-it.svg)](https://travis-ci.org/IonicaBizau/scrape-it/) [![Version](https://img.shields.io/npm/v/scrape-it.svg)](https://www.npmjs.com/package/scrape-it) [![Downloads](https://img.shields.io/npm/dt/scrape-it.svg)](https://www.npmjs.com/package/scrape-it)
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Travis](https://img.shields.io/travis/IonicaBizau/scrape-it.svg)](https://travis-ci.org/IonicaBizau/scrape-it/) [![Version](https://img.shields.io/npm/v/scrape-it.svg)](https://www.npmjs.com/package/scrape-it) [![Downloads](https://img.shields.io/npm/dt/scrape-it.svg)](https://www.npmjs.com/package/scrape-it) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>







> A Node.js scraper for humans.





Want to save time or not using Node.js? Try our [hosted API](https://scrape-it.saasify.sh).












## :cloud: Installation

```sh
Expand All @@ -24,6 +64,12 @@ yarn add scrape-it

:bulb: **ProTip**: You can install the [cli version of this module](https://github.com/IonicaBizau/scrape-it-cli) by running `npm install --global scrape-it-cli` (or `yarn global add scrape-it-cli`).







## FAQ


Expand All @@ -50,6 +96,12 @@ There is no fancy way to crawl pages with `scrape-it`. For simple scenarios, you
Use the `.scrapeHTML` to parse the HTML read from the local files using `fs.readFile`.








## :clipboard: Example


Expand Down Expand Up @@ -158,18 +210,26 @@ scrapeIt("https://ionicabizau.net", {









## :question: Get Help

There are few ways to get help:



1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:





## :memo: Documentation


Expand Down Expand Up @@ -268,12 +328,22 @@ For the format of the selector, please refer to the [Selectors section of the Ch














## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].


## :sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).

Expand All @@ -293,21 +363,102 @@ Thanks! :heart:
















## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

- `@web-master/node-web-scraper`
- `proxylist`
- `mit-ocw-scraper`
- `beervana-scraper`
- `bandcamp-scraper`
- `@tryghost/mg-webscraper`
- `cnn-market`
- `blockchain-notifier`
- `dncli`
- `degusta-scrapper`
- `trump-cabinet-picks`
- `cevo-lookup`
- `camaleon`
- `scrape-vinmonopolet`
- `do-fn`
- `university-news-notifier`
- `selfrefactor`
- `parn`
- `picarto-lib`
- `mix-dl`
- `jishon`
- `sahibinden`
- `sahibindenServer`
- `sgdq-collector`
- `ubersetzung`
- `ui-studentsearch`
- `paklek-cli`
- `egg-crawler`
- `@thetrg/gibson`
- `jobs-fetcher`
- `fmgo-marketdata`
- `rayko-tools`
- `scrape-it-cli`
- `leximaven`
- `codinglove-scraper`
- `vandalen.rhyme.js`
- `uniwue-lernplaetze-scraper`
- `blankningsregistret`
- `spon-market`
- `macoolka-net-scrape`
- `beervana-cli`
- `gatsby-source-bandcamp`
- `salesforcerelease-parser`
- `yu-ncov-scrape-dxy`
- `rs-api`
- `startpage-quick-search`
- `fa.js`
- `helyesiras`
- `flamescraper`
- `covidau`
- `3abn`
- `codementor`











## :scroll: License

[MIT][license] © [Ionică Bizău][website]






[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg

[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW

[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2016#license-mit
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@
"bloggify.json",
"bloggify/"
]
}
}

0 comments on commit 31fd260

Please sign in to comment.