diff --git a/.gitignore b/.gitignore index 61f2900..af96bda 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,6 @@ *~ *.log node_modules +*.env +.DS_Store +package-lock.json diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 10977ce..cb23d17 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -6,6 +6,7 @@ You can see below the API reference of this module. Returns the user profile url. #### Params + - **String** `user`: The CodeMentor username. #### Return @@ -15,6 +16,7 @@ Returns the user profile url. Scrapes the mentor profile. #### Params + - **String** `user`: The CodeMentor username. - **Function** `cb`: The callback function. @@ -25,6 +27,7 @@ Scrapes the mentor profile. Gets the mentor reviews. #### Params + - **String** `user`: The CodeMentor username. - **Function** `cb`: The callback function. diff --git a/README.md b/README.md index 8a4e9ae..dac12b0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ + + # codementor - [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Version](https://img.shields.io/npm/v/codementor.svg)](https://www.npmjs.com/package/codementor) [![Downloads](https://img.shields.io/npm/dt/codementor.svg)](https://www.npmjs.com/package/codementor) + [![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) [![Version](https://img.shields.io/npm/v/codementor.svg)](https://www.npmjs.com/package/codementor) [![Downloads](https://img.shields.io/npm/dt/codementor.svg)](https://www.npmjs.com/package/codementor) > A scraper for codementor.io. @@ -93,13 +95,15 @@ CodeMentor.mentorProfile("johnnyb", (err, data) => { }); ``` + + ## :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 from me, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: + 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: ## :memo: Documentation @@ -109,6 +113,7 @@ There are few ways to get help: Returns the user profile url. #### Params + - **String** `user`: The CodeMentor username. #### Return @@ -118,6 +123,7 @@ Returns the user profile url. Scrapes the mentor profile. #### Params + - **String** `user`: The CodeMentor username. - **Function** `cb`: The callback function. @@ -128,6 +134,7 @@ Scrapes the mentor profile. Gets the mentor reviews. #### Params + - **String** `user`: The CodeMentor username. - **Function** `cb`: The callback function. @@ -148,6 +155,7 @@ this takes time. You can integrate and use these projects in your applications * However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it: - Starring and sharing the projects you like :rocket: + - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone). - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6` diff --git a/package.json b/package.json index 661ad61..de34d18 100644 --- a/package.json +++ b/package.json @@ -52,4 +52,4 @@ "example": "example" }, "devDependencies": {} -} \ No newline at end of file +}