duck-duck-scrape - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

package.json

 {
   "name": "duck-duck-scrape",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "A DuckDuckGo scraper for Node.js.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # duck-duck-scrape
 A DuckDuckGo scraper NPM module
 
+**Note: This isn't endorsed by DuckDuckGo in any way.**
+
+[![NPM](https://nodei.co/npm/duck-duck-scrape.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/duck-duck-scrape/)
+
 # Installation
 `npm install --save duck-duck-scrape`
+
+# Setup
+```javascript
+const DuckDuckScrape = require("duck-duck-scrape");
+const ddg = new DuckDuckScrape();
+```
+# Safe Search
+```
+ 1 = Safe
+-1 = Moderate
+-2 = Off
+
+For non-search functions safe search is a boolean
+```
+# Functions
+
+```javascript
+  //Search 
+  ddg.search(query<String>, safe<Integer>, locale<locale string>) // returns a Promise
+  
+  //Autocomplete
+  ddg.query(query<String>) // returns a Promise
+  
+  //Image Search (unstable, not sure why)
+  ddg.image(query<String>, safe<Boolean>, locale<locale string>) // returns a Promise
+  
+  //Video Search
+  ddg.video(query<String>, safe<Boolean>, locale<locale string>) // returns a Promise
+  
+  //Amazon Search
+  ddg.amazon(query<String>, safe<Boolean>) // returns a Promise
+  
+  //Twitter Search
+  ddg.twitter(handle<String>) // returns a Promise
+```
+
+# Example
+``` javascript
+ddg.autocomplete("how to convert to ").then((value) => { console.log(value[0].phrase); }); // "how to convert to pdf"
+```

No alert changes

Improved metrics

Total package byte prevSize

7928

increased by31.24%

Number of package files

4

increased by33.33%

Number of lines in readme file

50

increased by733.33%

No dependency changes