From e0ba640c9e2b6bd456dfebacdf0cb1b15f1b5a12 Mon Sep 17 00:00:00 2001 From: Michael Jae-Yoon Chung Date: Thu, 2 May 2019 14:49:43 -0700 Subject: [PATCH] WIP: README --- package.json | 6 ++++-- src/README.md | 11 +++++++++++ 2 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 src/README.md diff --git a/package.json b/package.json index c1a46a7..71ab87c 100644 --- 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 new file mode 100644 index 0000000..e5032af --- /dev/null +++ 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