hubot-archive-today - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

Gruntfile.js

@@ -10,3 +10,3 @@ 'use strict';
           reporter: 'spec',
-          require: 'coffee-script'
+          require: 'coffee-script/register'
         },
@@ -34,2 +34,2 @@ src: ['test/**/*.coffee']
   grunt.registerTask('default', ['test']);
-};
+};

package.json

 {
   "name": "hubot-archive-today",
   "description": "A Hubot script for archiving the contents of a URL on Archive.today.",
-  "version": "1.1.1",
-  "author": "Ian Lai <[e-mail]>",
+  "version": "1.1.2",
+  "author": "Ian Lai <[e-mail]>",
   "license": "MIT",
-
-  "keywords": "hubot, hubot-scripts, archive.today, backup, clone, url, bookmark",
-
+  "keywords": "hubot, hubot-scripts, archive.today, backup, clone, url, bookmark, history",
   "repository": {
@@ -14,17 +12,12 @@ "type": "git",
   },
-
   "bugs": {
     "url": "https://github.com/ClaudeBot/hubot-archive-today/issues"
   },
-
-  "dependencies": {
-  },
-
+  "dependencies": {},
   "peerDependencies": {
     "hubot": "2.x"
   },
-
   "devDependencies": {
-    "chai": "^2.1.1",
-    "coffee-script": "1.6.3",
+    "chai": "^3.0.0",
+    "coffee-script": "^1.9.3",
     "grunt": "^0.4.5",
@@ -34,3 +27,3 @@ "grunt-cli": "^0.1.13",
     "grunt-mocha-test": "~0.12.7",
-    "grunt-release": "~0.11.0",
+    "grunt-release": "~0.13.0",
     "hubot": "2.x",
@@ -42,5 +35,3 @@ "matchdep": "~0.3.0",
   },
-
   "main": "index.coffee",
-
   "scripts": {
@@ -47,0 +38,0 @@ "test": "grunt test"

README.md

 # hubot-archive-today
 
+[![Build Status](https://travis-ci.org/ClaudeBot/hubot-archive-today.svg)](https://travis-ci.org/ClaudeBot/hubot-archive-today)
+[![devDependency Status](https://david-dm.org/ClaudeBot/hubot-archive-today/dev-status.svg)](https://david-dm.org/ClaudeBot/hubot-archive-today#info=devDependencies)
+
 A Hubot script for archiving the contents of a URL on Archive.today.
@@ -7,16 +10,29 @@
 
-## Installation
 
-In hubot project repo, run:
+## Installation via NPM
 
-`npm install hubot-archive-today --save`
+1. Install the __hubot-archive-today__ module as a Hubot dependency by running:
 
-Then add **hubot-archive-today** to your `external-scripts.json`:
+    ```
+    npm install --save hubot-archive-today
+    ```
 
-```json
-[
-  "hubot-archive-today"
-]
-```
+2. Enable the module by adding the __hubot-archive-today__ entry to your `external-scripts.json` file:
 
+    ```json
+    [
+        "hubot-archive-today"
+    ]
+    ```
+
+3. Run your bot and see below for available config / commands
+
+
+## Commands
+
+Command | Description
+--- | ---
+hubot archive `url` | Archives the contents of `url` and returns the Archive.today link
+
+
 ## Sample Interaction
@@ -26,3 +42,3 @@
 user1>> hubot archive https://www.google.com/
-hubot>> https://archive.today/baTKw
+hubot>> user1: https://archive.today/baTKw
 ```

No alert changes

Improved metrics

Total package byte prevSize

5417

increased by13.68%

Number of lines in readme file

43

increased by59.26%

Worsened metrics

Lines of code

28

decreased by-3.45%

No dependency changes