Merge pull request #4 from mmkal/explicit-keys-test

Explicit keys test

Author: mmkal

.travis.yml

@@ -6,7 +6,7 @@ cache:
 notifications:
   email: true
 node_js:
-  - '7'
+  - '8'
   - '6'
 before_script:
   - npm prune

.vscode/tasks.json

@@ -1,14 +1,15 @@
 {
     "version": "0.1.0",
-    "command": "tsc",
+    "command": "npm",
     "isShellCommand": true,
     "showOutput": "always",
-    "args": ["--sourceMap", "--watch", "--project"],
+    "args": ["run"],
     "tasks": [
         {
-            "taskName": ".",
+            "taskName": "build",
             "problemMatcher": "$tsc-watch",
             "showOutput": "always",
+            "args": ["--", "--sourceMap", "--watch"],
             "isBuildCommand": true,
             "isBackground": true
         },

README.md

@@ -1,4 +1,60 @@
 # handy-redis
-A wrapper around node_redis with Promise and TypeScript support.
+A wrapper around [node_redis](https://npmjs.com/package/redis) with Promise and TypeScript support.
 
-[![Build Status](https://travis-ci.org/mmkal/hodor.svg?branch=master)](https://travis-ci.org/mmkal/handy-redis)
+[![Build Status](https://travis-ci.org/mmkal/handy-redis.svg?branch=master)](https://travis-ci.org/mmkal/handy-redis)
+
+## Why
+
+[node_redis](https://npmjs.com/package/redis) doesn't support Promises out-of-the-box - you have to use bluebird's `promisifyAll`, which has the side effect of removing all TypeScript/intellisense support from the package.
+
+This package exclusively uses Promises, and the TypeScript types are generated from the official redis documentation and examples, so it's much easier to know what parameters a command expects.
+
+## Using
+
+```cli
+npm install --save handy-redis
+```
+
+ES6/TypeScript:
+```JavaScript
+import { createHandyClient } from 'handy-redis';
+
+(async function() {
+    const client = createHandyClient();
+    // or, call createHandyClient(opts) using opts for https://npmjs.com/package/redis
+    // or, call createHandyClient(oldClient) where oldClient is an existing node_redis client.
+
+    await client.set('foo', 'bar');
+    const foo = await client.get('foo');
+    console.log(foo);
+})();
+```
+
+Vanilla JS:
+```JavaScript
+const handyRedis = require('handy-redis');
+
+const client = handyRedis.createHandyClient();
+
+client
+    .set('foo', 'bar')
+    .then(() => client.get('foo'))
+    .then(foo => console.log(foo));
+```
+
+The package is published with TypeScript types, with the redis documentation and response type attached to each command:
+![](./docs/intellisense.png)
+
+## Development
+
+Most of the package is generated by running sample commands from the redis documentation repo.
+
+```cli
+git clone https://github.com/mmkal/handy-redis --recursive
+npm install
+npm test
+```
+
+`npm test` triggers `npm run build` before running the tests - and the `build` script generates the client before using TypeScript to compile it.
+
+If you cloned without `--recursive` you'll need to run `git submodule update --init` to get the redis-doc repo locally.