readme & package.Json

FGRibreau · Aug 20, 2014 · f631c95 · f631c95
1 parent 5cac629
commit f631c95
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -3,11 +3,11 @@
 
 # What is it?
 
-*dot-clipboard* - a daemon that runs scripts from `~/.dot-clipboard` each time the clipboard content change.
+*dot-clipboard* monitor your clipboard and runs user-defined scripts based on the clipboard content.
 
-### Sorry... what?
+### I am not a child, what is it?
 
-*dot-clipboard* monitor your clipboard and runs user-defined scripts depending on the clipboard content.
+*dot-clipboard* is a nodejs daemon that runs javascript scripts located in `~/.dot-clipboard` each time the clipboard content change.
 
 ### Ok... but why?
 
@@ -37,7 +37,13 @@ Believe it or not **we use the clipboard the same way since the 70s**. Yes, we'v
 - customizable concurrency per script
 - fully-asynchronous scripts : each *clipboard change* events are duplicated for each script, queued, and then consumed asynchronously
 
-# How do I write a script ?
+# How do I install it?
+
+```
+npm install dot-clipboard -g
+```
+
+# How do I write my first script?
 
 - Start `dot-clipboard`
 - Open `~/.dot-clipboard`, an save the above `myScript.js` file inside it.

diff --git a/package.json b/package.json
@@ -1,10 +1,25 @@
 {
   "name": "dot-clipboard",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": ".clipboard - a daemon that runs scripts from `~/.dot-clipboard` each time the clipboard content change",
   "main": "index.js",
+  "keywords": ["clipboard", "workflow", "automation"],
+  "homepage":"https://github.com/FGRibreau/dot-clipboard",
   "author": "Francois-Guillaume Ribreau <npm@fgribreau.com> (http://fgribreau.com/)",
   "license": "MIT",
+  "preferGlobal": true,
+  "bin":"./index.js",
+  "repository" :{
+      "type" : "git"
+    , "url" : "https://github.com/FGRibreau/dot-clipboard.git"
+  },
+  "bugs":{
+    "url" : "https://github.com/FGRibreau/issues"
+  },
+  "contributors": [],
+  "scripts": {
+    "postinstall": "mkdir -p ~/.dot-clipboard;cp ./examples ~/.dot-clipboard"
+  },
   "dependencies": {
     "async": "^0.9.0",
     "clipboard-watcher": "0.0.3",