flam - npm Package Compare versions

Comparing version 1.0.13 to 1.0.14

examples/app.js

@@ -6,3 +6,4 @@ /*
 **
-**  Gerry Gold, April 2015
+**  Gerry Gold, March 2015
+** (And the record-breaking winter in Boston refuses to leave.)
 */
@@ -9,0 +10,0 @@ var Flam = require( "../flam" );

flam.js

@@ -276,3 +276,3 @@ #!/usr/bin/env node
     program
-        .version( "1.0.13" )
+        .version( "1.0.14" )
         .option( "-f, --file <filename>", "set filename content to be stored" )
@@ -279,0 +279,0 @@ .option( "-c, --content <inline data>", "set data directly in the command line to be stored" )

package.json

 {
   "name": "flam",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "description": "Free and secure data storage: no account or registration required",
@@ -12,3 +12,2 @@ "main": "./flam.js",
     "free",
-    "no registration",
     "borrow",
@@ -21,3 +20,2 @@ "storage",
     "Belgian Ale",
-    "no account",
     "key value store",
@@ -24,0 +22,0 @@ "secure",

README.md

 flam
 ====
 
-Free and secure data storage: no account or registration required
+free and secure data storage
 
@@ -42,18 +42,30 @@ Overview
 
-cd into flam's root directory, where flam.js is located. Execute the script
+cd into flam's root directory, where `flam.js` is located. Execute the script
 without arguments:
 
-    $ ./flam.js
+    ./flam.js
 
 The following message should display:
 
-    Error: You must change the placeholder password in config/config.json.
+    Error: You must change the placeholder password in `config/config.json`.
 
-flam.js will not execute unless you change the preset password. Edit
-config/config.json, as the message instructs.
+`flam.js` will not execute unless you change the preset password. Edit
+`config/config.json`, as the message instructs.
 
 You've changed the password, right? Good. Let's try that again:
 
-    $ ./flam.js
+    ./flam.js
 
+What?! Another error message?
+
+Ok, one more tiny hurdle; you need to supply a Google API key.
+
+If you don't have one,
+[it's easy to get](https://developers.google.com/url-shortener "Google's URL Shortener API"). There's already a place for you to
+place the API key in `config/config.json`.
+
+You added your API key. One more time, I promise!
+
+    ./flame.js
+
 You should see Usage and options:
@@ -75,3 +87,3 @@
 
-    $ ./flam.js --content "My Swiss Bank Account No: 1337-1337-1337"
+    ./flam.js --content "My Swiss Bank Account No: 1337-1337-1337"
 
@@ -87,14 +99,14 @@ Response is displayed:
 
-    $ ./flam --get <key>
+    ./flam --get <key>
 
 The command line interface by default keeps a simple log of write events
-(using -f or -c options). View keys.log to see your first entry.
+(using -f or -c options). View `keys.log` to see your first entry.
 
 Let's safely store the content of a text file.
 
-    $ ./flam.js --file ~/essential_ingredients.txt
+    ./flam.js --file ~/essential_ingredients.txt
 
-Use the same get option to retrieve the content
+Use the same get option to retrieve the content.
 
-    $ ./flam.js -g <key>
+    ./flam.js -g <key>
 
@@ -105,3 +117,3 @@ Another example using flam as a module.
 
-    $ node app.js
+    node app.js
 
@@ -108,0 +120,0 @@

No alert changes

Improved metrics

Total package byte prevSize

19453

increased by1.78%

Lines of code

326

increased by0.31%

Number of lines in readme file

134

increased by9.84%

No dependency changes