amalgamatic-drupal6 - npm Package Compare versions

Comparing version 4.0.1 to 4.0.2

CHANGELOG.md

 
+## [**4.0.2**](https://github.com/ucsf-ckm/amalgamatic-drupal6/issues?milestone=8&state=closed)
+- [**#1**](https://github.com/ucsf-ckm/amalgamatic-drupal6/issues/1) Document API
+- [**#6**](https://github.com/ucsf-ckm/amalgamatic-drupal6/issues/6) Travis-CI
+
 ## [**4.0.1**](https://github.com/ucsf-ckm/amalgamatic-drupal6/issues?milestone=7&state=closed)
@@ -3,0 +7,0 @@ - [**#14**](https://github.com/ucsf-ckm/amalgamatic-drupal6/issues/14) withCredentials default to false

package.json

@@ -8,3 +8,3 @@ {
   },
-  "version": "4.0.1",
+  "version": "4.0.2",
   "dependencies": {
@@ -11,0 +11,0 @@ "cheerio": "^0.17.0",

README.md

@@ -0,4 +1,39 @@
+[![Build Status](https://travis-ci.org/ucsf-ckm/amalgamatic-drupal6.svg?branch=master)](https://travis-ci.org/ucsf-ckm/amalgamatic-drupal6)
+
 amalgamatic-drupal6
 ===================
 
-Plugin for amalgamatic to search a Drupal 6 website
+Plugin for [Amalgamatic](https://github.com/ucsf-ckm/amalgamatic) to search a Drupal 6 website
+
+## Installation
+
+Install amalgamatic and this plugin via `npm`:
+
+`npm install amalgamatic amalgamatic-drupal6`
+
+## Usage
+
+````
+var amalgamatic = require('amalgamatic'),
+    drupal6 = require('amalgamatic-drupal6');
+
+// Set the URL to point to your Drupal 6 search page
+drupal6.setOptions({url: 'http://www.library.ucsf.edu/search/node'});
+
+// Add this plugin to your Amalgamatic instance along with any other plugins you've configured.
+amalgamatic.add('drupal6', drupal6);
+
+//Use it!
+var callback = function (err, results) {
+    if (err) {
+        console.dir(err);
+    } else {
+        results.forEach(function (result) {
+            console.log(result.name);
+            console.dir(result.data);
+        });
+    }
+};
+
+amalgamatic.search({searchTerm: 'medicine'}, callback);
+````

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11104

increased by12.82%

Number of package files

10

increased by11.11%

Number of lines in readme file

40

increased by700%

No dependency changes