Updated docs

CONTRIBUTING.md

@@ -1,29 +1,29 @@
 # :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles:  :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk:
 
 So, you want to contribute to this project! That's awesome. However, before
-doing so, please read the following simple steps on how to contribute. This will
-make your life easier and avoid wasting time on things which are not
+doing so, please read the following simple steps how to contribute. This will
+make the life easier and will avoid wasting time on things which are not
 requested. :sparkles:
 
 ## Discuss the changes before doing them
  - First of all, open an issue in the repository, using the [bug tracker][1],
    describing the contribution you would like to make, the bug you found or any
    other ideas you have. This will help us to get you started on the right
-   track.
+   foot.
 
  - If it makes sense, add the platform and software information (e.g. operating
    system, Node.JS version etc.), screenshots (so we can see what you are
    seeing).
 
- - It is recommended to wait for feedback before continuing with next steps.
+ - It is recommended to wait for feedback before continuing to next steps.
    However, if the issue is clear (e.g. a typo) and the fix is simple, you can
    continue and fix it.
 
 ## Fixing issues
  - Fork the project in your account and create a branch with your fix:
    `some-great-feature` or `some-issue-fix`.
 
- - Commit your changes in that branch, writing code following the
+ - Commit your changes in that branch, writing the code following the
    [code style][2]. If the project contains tests (generally, the `test`
    directory), you are encouraged to add a test as well. :memo:
 

DOCUMENTATION.md

@@ -4,7 +4,6 @@ You can see below the API reference of this module.
 
 ### `scrapeIt(url, opts, cb)`
 A scraping module for humans.
-
 #### Params
 - **String|Object** `url`: The page url or request options.
 - **Object** `opts`: The options passed to `scrapeHTML` method.
@@ -15,7 +14,6 @@ A scraping module for humans.
 
 ### `scrapeIt.scrapeHTML($, opts)`
 Scrapes the data in the provided element.
-
 #### Params
 - **Cheerio** `$`: The input element.
 - **Object** `opts`: An object containing the scraping information.
@@ -32,6 +30,8 @@ Scrapes the data in the provided element.
            the attribute name.
          - `trim` (Boolean): If `false`, the value will *not* be trimmed
            (default: `true`).
+         - `closest` (String): If provided, returns the first ancestor of
+           the given element.
          - `eq` (Number): If provided, it will select the *nth* element.
          - `listItem` (Object): An object, keeping the recursive schema of
            the `listItem` object. This can be used to create nested lists.
@@ -54,6 +54,11 @@ Scrapes the data in the provided element.
                  selector: ".article-content"
                , how: "html"
              }
+           , traverseOtherNode: {
+                 selector: ".upperNode"
+               , closest: "div"
+               , convert: x => x.length
+             }
          }
      }
   }

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Ionică Bizău <[email protected]> (http://ionicabizau.net)
+Copyright (c) 2016-17 Ionică Bizău <[email protected]> (http://ionicabizau.net)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -114,7 +114,6 @@ scrapeIt("http://ionicabizau.net", {
 
 ### `scrapeIt(url, opts, cb)`
 A scraping module for humans.
-
 #### Params
 - **String|Object** `url`: The page url or request options.
 - **Object** `opts`: The options passed to `scrapeHTML` method.
@@ -125,7 +124,6 @@ A scraping module for humans.
 
 ### `scrapeIt.scrapeHTML($, opts)`
 Scrapes the data in the provided element.
-
 #### Params
 - **Cheerio** `$`: The input element.
 - **Object** `opts`: An object containing the scraping information.
@@ -142,6 +140,8 @@ Scrapes the data in the provided element.
            the attribute name.
          - `trim` (Boolean): If `false`, the value will *not* be trimmed
            (default: `true`).
+         - `closest` (String): If provided, returns the first ancestor of
+           the given element.
          - `eq` (Number): If provided, it will select the *nth* element.
          - `listItem` (Object): An object, keeping the recursive schema of
            the `listItem` object. This can be used to create nested lists.
@@ -164,6 +164,11 @@ Scrapes the data in the provided element.
                  selector: ".article-content"
                , how: "html"
              }
+           , traverseOtherNode: {
+                 selector: ".upperNode"
+               , closest: "div"
+               , convert: x => x.length
+             }
          }
      }
   }
@@ -210,10 +215,13 @@ If you are using this library in one of your projects, add it in this list. :spa
  - [`bandcamp-scraper`](https://github.com/masterT/bandcamp-scraper) (by Simon Thiboutôt)—A scraper for https://bandcamp.com
  - [`cevo-lookup`](https://npmjs.com/package/cevo-lookup) (by Zack Boehm)—Searchs the CEVO Suspension List for bans by SteamID
  - [`codementor`](https://github.com/IonicaBizau/codementor#readme)—A scraper for codementor.io.
+ - [`degusta-scrapper`](https://github.com/yohendry/degusta-scrapper#readme) (by yohendry hurtado)—desgusta scrapper for alexa skill
  - [`proxylist`](https://github.com/selfrefactor/proxylist#readme) (by self_refactor)—Get free proxy list
+ - [`rs-api`](https://github.com/alexisio/rs-api#readme) (by Alex Kempf)—Simple wrapper for RuneScape APIs written in node.
  - [`sahibinden`](https://npmjs.com/package/sahibinden) (by Cagatay Cali)—Simple sahibinden.com bot
  - [`sahibindenServer`](https://npmjs.com/package/sahibindenServer) (by Cagatay Cali)—Simple sahibinden.com bot server side
  - [`sgdq-collector`](https://github.com/bcongdon/sgdq-collector#readme) (by Benjamin Congdon)—Collects Twitch / Donation information and pushes data to Firebase
+ - [`trump-cabinet-picks`](https://github.com/LindaHaviv/trump-cabinet-picks#readme) (by Linda Haviv)—NYT cabinet predictions for Trump admin.
  - [`ubersetzung`](https://github.com/selfrefactor/ubersetzung#readme) (by self_refactor)—translate words with examples from German to English
  - [`ui-studentsearch`](https://github.com/rkkautsar/ui-studentsearch#readme) (by Rakha Kanz Kautsar)—API for majapahit.cs.ui.ac.id/studentsearch