WIP: README

mjyc · May 2, 2019 · e0ba640 · e0ba640
1 parent e8a2384
commit e0ba640
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -1,15 +1,17 @@
 {
   "name": "jammerjs",
   "version": "0.0.0",
-  "description": "",
+  "description": "A Cycle.js driver for pose detection using TensorFlow.js-powered PoseNet",
   "scripts": {
     "prebuild": "rimraf lib && mkdirp lib",
     "build": "babel src -d lib",
     "browserify": "mkdirp dist && browserify src/index.js --standalone HandtrackTouch -t babelify --outfile dist/index.js"
   },
-  "repository": "https://github.com/mjyc/jammer.js",
   "author": "Michael Jae-Yoon Chung",
   "license": "MIT",
+  "bugs": "https://github.com/mjyc/jammerjs/issues",
+  "repository": "https://github.com/mjyc/jammerjs",
+  "main": "lib/index.js",
   "dependencies": {
     "hammer-simulator": "0.0.1",
     "handtrackjs": "0.0.13"

diff --git a/src/README.md b/src/README.md
@@ -0,0 +1,11 @@
+# Jammer.js
+
+Add hand gestures to your app.
+
+Jammer.js = [Hammer.js](https://github.com/hammerjs/hammer.js) + [Handtrack.js](https://github.com/victordibia/handtrack.js/).
+
+```
+Picture here
+```
+
+Demo at Codesandbox