flam - npm Package Compare versions

Comparing version 1.0.0 to 1.0.2

package.json

 {
   "name": "flam",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Free and secure data storage: no account or registration required",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "main": "./flam.js",
+
+  "bin": {
+    "flam": "./flam.js"
   },
+
   "repository": {
@@ -14,15 +16,36 @@ "type": "git",
   "keywords": [
+    "free",
+    "no registration",
+    "borrow",
+    "storage",
+    "drummer",
+    "flim-flam",
     "data store",
     "noSQL",
+    "Belgian Ale",
+    "no account",
     "key value store",
-    "free",
-    "Google",
-    "crypto"
+    "secure",
+    "pilfer"
   ],
-  "author": "[e-mail]",
+  "author": {
+    "name": "Gerry Gold",
+    "email": "[e-mail]"
+  },
   "license": "MIT",
+  "files": [
+    "flam.js, LICENSE", "examples", "config"
+  ],
   "bugs": {
     "url": "https://github.com/gold/flam/issues"
   },
-  "homepage": "https://github.com/gold/flam"
+  "homepage": "https://github.com/gold/flam",
+  "dependencies": {
+    "commander": "^2.7.1",
+    "dateformat": "^1.0.11",
+    "needle": "^0.8.2",
+    "prompt-sync": "^1.0.0",
+    "randomstring": "^1.0.3",
+    "synchro-prompt": "^1.0.2"
+  }
 }

README.md

@@ -1,6 +0,120 @@
-# flam
+flam
+====
+
 Free and secure data storage: no account or registration required
 
-Work in progress... 
+Overview
+--------
 
-First release will be available April 2015.
+You need a data store. You want it to work. You want it to scale. You want it
+simple and secure. You don't want to set it up and configure it. You don't
+want to maintain it. And you don't want to pay for it.
+
+Where is the data stored? There's a company in Mountain View, CA which is
+known for its search engine. Their servers do all of the heavy lifting.
+
+flam is fun because it's free, and just works!
+
+Security
+--------
+
+Be default flam keeps your data safe and cozy via AES crypto, based on the
+Rijndael cipher. Belgium makes great ales and cryptographic algorithms.
+
+
+Installation
+------------
+
+npm install flam
+
+
+Examples
+--------
+
+flam can be used in two ways:
+
+1. as a command line program
+2. conventionally require flam as any other npm module
+
+Let's try a few examples from the command line. Open up a terminal.
+
+cd into flam's root directory, where flam.js is located. Execute the script
+without arguments:
+
+    $ ./flam.js
+
+The following message should display:
+
+    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.
+
+You've changed the password, right? Good. Let's try that again:
+
+    $ ./flam.js
+
+You should see Usage and options:
+
+    Usage: flam [options]
+
+    Options:
+
+      -h, --help                   output usage information
+      -V, --version                output the version number
+      -f, --file <filename>        set filename content to be stored
+      -c, --content <inline data>  set data directly in the command line to be stored
+      -g, --get <key>              get value referenced by key
+      -d, --disable-encryption     disable encryption (default is crypto enabled)
+
+Let's try a basic example to store content expressed directly in the command
+line:
+
+    $ ./flam.js --content "My Swiss Bank Account No: 1337-1337-1337"
+
+Response is displayed:
+
+    Content successfully stored with key: 191yFg
+
+Of course, the key in this documentation is ficticious; the key that you see
+in your own terminal is real.
+
+Let's be sure and retrieve your stored content. Use your key instead of the fake one:
+
+    $ ./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.
+
+Let's safely store the content of a text file.
+
+    $ ./flam.js --file ~/essential_ingredients.txt
+
+Use the same get option to retrieve the content
+
+    $ ./flam.js -g <key>
+
+Another example using flam as a module.
+
+cd in to the examples directory and run the app:
+
+    $ node app.js
+
+
+Caveats
+-------
+
+To preserve balance in the universe, the free service that flam provides
+has some limitations:
+
+  1. A record cannot be updated or deleted.
+  2. A content record cannot exceed 45K.
+  3. Expiration of stored data, if any exists, is unknown.
+
+These restrictions may be too severe for your requirements in a professional
+setting. That is a judgement you must make yourself.
+
+Have fun!
+
+  Gerry Gold
+  March 2015

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6223

increased by240.99%

Number of package files

5

increased by66.67%

Lines of code

27

increased byInfinity%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

121

increased by1628.57%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

6

increased byInfinity%

Dependency changes

• + Addedcommander@^2.7.1

• + Addeddateformat@^1.0.11

• + Addedneedle@^0.8.2

• + Addedprompt-sync@^1.0.0

• + Addedrandomstring@^1.0.3

• + Addedsynchro-prompt@^1.0.2

• + Addedansi-regex@0.2.1(transitive)

• + Addedansi-styles@1.1.0(transitive)

• + Addedarray-find-index@1.0.2(transitive)

• + Addedcamelcase@2.1.1(transitive)

• + Addedcamelcase-keys@2.1.0(transitive)

• + Addedchalk@0.5.1(transitive)

• + Addedcommander@2.20.3(transitive)

• + Addedcurrently-unhandled@0.4.1(transitive)

• + Addeddateformat@1.0.12(transitive)

• + Addeddecamelize@1.2.0(transitive)

• + Addederror-ex@1.3.2(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedfind-up@1.1.2(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedget-stdin@4.0.1(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedhas-ansi@0.1.0(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedhosted-git-info@2.8.9(transitive)

• + Addediconv-lite@0.4.24(transitive)

• + Addedindent-string@2.1.0(transitive)

• + Addedis-arrayish@0.2.1(transitive)

• + Addedis-core-module@2.16.1(transitive)

• + Addedis-finite@1.1.0(transitive)

• + Addedis-utf8@0.2.1(transitive)

• + Addedload-json-file@1.1.0(transitive)

• + Addedloud-rejection@1.6.0(transitive)

• + Addedmap-obj@1.0.1(transitive)

• + Addedmeow@3.7.0(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedneedle@0.8.2(transitive)

• + Addednormalize-package-data@2.5.0(transitive)

• + Addedobject-assign@4.1.1(transitive)

• + Addedparse-json@2.2.0(transitive)

• + Addedpath-exists@2.1.0(transitive)

• + Addedpath-parse@1.0.7(transitive)

• + Addedpath-type@1.1.0(transitive)

• + Addedpify@2.3.0(transitive)

• + Addedpinkie@2.0.4(transitive)

• + Addedpinkie-promise@2.0.1(transitive)

• + Addedprompt-sync@1.0.0(transitive)

• + Addedrandombytes@2.1.0(transitive)

• + Addedrandomstring@1.3.1(transitive)

• + Addedread-pkg@1.1.0(transitive)

• + Addedread-pkg-up@1.0.1(transitive)

• + Addedreadline-sync@0.4.10(transitive)

• + Addedredent@1.0.0(transitive)

• + Addedrepeating@2.0.1(transitive)

• + Addedresolve@1.22.10(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsemver@5.7.2(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedspdx-correct@3.2.0(transitive)

• + Addedspdx-exceptions@2.5.0(transitive)

• + Addedspdx-expression-parse@3.0.1(transitive)

• + Addedspdx-license-ids@3.0.21(transitive)

• + Addedstrip-ansi@0.3.0(transitive)

• + Addedstrip-bom@2.0.0(transitive)

• + Addedstrip-indent@1.0.1(transitive)

• + Addedsupports-color@0.2.0(transitive)

• + Addedsupports-preserve-symlinks-flag@1.0.0(transitive)

• + Addedsynchro-prompt@1.1.0(transitive)

• + Addedtrim-newlines@1.0.0(transitive)

• + Addedvalidate-npm-package-license@3.0.4(transitive)