📝

Author: IonicaBizau

.gitignore

@@ -2,4 +2,4 @@
 *.swo
 *~
 *.log
-node_modules
+node_modules

README.md

@@ -1,6 +1,22 @@
-![](http://i.imgur.com/AI9aB44.png)
+<!---------------------------------------------------------------------------->
+<!-- STOP, LOOK & LISTEN!                                                   -->
+<!-- ====================                                                   -->
+<!-- Do NOT edit this file directly since it's generated from a template    -->
+<!-- file, using https://github.com/IonicaBizau/node-blah                   -->
+<!--                                                                        -->
+<!-- If you found a typo in documentation, fix it in the source files       -->
+<!-- (`lib/*.js`) and make a pull request.                                  -->
+<!--                                                                        -->
+<!-- If you have any other ideas, open an issue.                            -->
+<!--                                                                        -->
+<!-- Please consider reading the contribution steps (CONTRIBUTING.md).      -->
+<!-- * * * Thanks! * * *                                                    -->
+<!---------------------------------------------------------------------------->
+
+[![share-term](http://i.imgur.com/AI9aB44.png)](#)
+
+# `$ share-term` [![Donate now][donate-now]][paypal-donations]
 
-# `$ share-term`
 Share the terminal with your friends.
 
 It's possible to share it into another terminal or in a browser, both with request
@@ -11,14 +27,43 @@ would be really appreciated. :smile: :heart:
 
 ## Installation
 
+You can install the package globally and use it as command line tool:
+
 ```sh
-$ npm install -g share-term
+$ npm i -g share-term
 ```
 
-For the help content, run:
+Then, run `share-term --help` and see what the CLI tool can do.
 
 ```sh
-$ share-term -h
+$ share-term --help
+share-term --help
+Share the terminal with your friends.
+
+usage: share-term [action] [options]
+
+actions:
+  get <id> [--control]     Connect to a terminal session. If `--control`
+                           options is passed, remote control will be
+                           requested.
+  welcome <host> <id>      This action is used internally when starting
+                           the terminal sharing.
+
+options:
+  -v, --version            Displays version information.
+  -h, --help               Displays this help.
+  -c, --control            Used to request remote control when the client
+                           is connecting from a terminal.
+
+examples:
+  share-term               # Starts a shared terminal session
+  share-term get <id>      # Connects to the terminal session with id <id>
+  share-term get <id> -c   # Connects and asks for remote control in the
+                           # terminal session with id <id>
+
+Documentation can be found at https://github.com/Share-Term/share-term
+Support Share Term now: http://share-term.me/support
+
 ```
 
 ## Usage
@@ -48,17 +93,25 @@ To join a terminal session, having the id `<id>` you have two ways:
     ```
 
 ## Documentation
-If you want to use this library as module, check out the [DOCUMENTATION](/DOCUMENTATION.md) file.
+
+For full API reference, see the [DOCUMENTATION.md][docs] file.
 
 ## How to contribute
-1. File an issue in the repository, using the bug tracker, describing the
-   contribution you'd like to make. This will help us to get you started on the
-   right foot.
-2. Fork the project in your account and create a new branch:
-   `your-great-feature`.
-3. Commit your changes in that branch.
-4. Open a pull request, and reference the initial issue in the pull request
-   message.
+Have an idea? Found a bug? See [how to contribute][contributing].
+
+## Press Highlights
+None yet. If you wrote or found an article about this project, [add it][contributing] in this section.  :memo:
+
+## Who uses this
+If you are using this library in one of your projects, add it in this list. :sparkles:
 
 ## License
-See the [LICENSE](./LICENSE) file.
+[KINDLY][license] © [Ionică Bizău][website]–The [LICENSE](/LICENSE) file contains
+a copy of the license.
+
+[license]: http://ionicabizau.github.io/kindly-license/?author=Ionic%C4%83%20Biz%C4%83u%20%[email protected]%3E&year=2015
+[contributing]: /CONTRIBUTING.md
+[website]: http://ionicabizau.net
+[docs]: /DOCUMENTATION.md
+[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MG98D7NPFZ3MG
+[donate-now]: http://i.imgur.com/6cMbHOC.png

bin/share-term

@@ -17,9 +17,10 @@ const HOST = "http://share-term.me/";
 Logger.config.displayDate = false;
 Logger.config.logLevel = 4;
 
-process.stdin.setEncoding("utf8");
-process.stdin.setRawMode(true);
-
+if (process.stdin.setRawMode) {
+    process.stdin.setEncoding("utf8");
+    process.stdin.setRawMode(true);
+}
 
 // CLI options
 switch (process.argv[2]) {

package.json

@@ -7,32 +7,35 @@
     "share-term": "./bin/share-term"
   },
   "devDependencies": {},
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
   "author": "Ionică Bizău <[email protected]>",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/IonicaBizau/share-term.git"
-  },
+  "license": "KINDLY",
   "keywords": [
     "share",
     "terminal",
     "client"
   ],
-  "bugs": {
-    "url": "https://github.com/IonicaBizau/share-term/issues"
-  },
-  "homepage": "https://github.com/IonicaBizau/share-term",
   "dependencies": {
-    "ctrl-c": "^1.1.0",
+    "bug-killer": "^4.0.0",
+    "cli-resize": "^1.0.0",
+    "ctrl-c": "^2.0.0",
+    "oargv": "^2.0.0",
     "open": "^0.0.5",
-    "bug-killer": "^1.0.0",
-    "pty.js": "^0.2.7",
-    "socket.io-client": "^1.3.5",
-    "ul": "^2.1.0",
-    "oargv": "^1.2.0",
-    "cli-resize": "^1.0.0"
+    "pty.js": "^0.3.0",
+    "socket.io-client": "^1.3.7",
+    "ul": "^5.0.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Share-Term/share-term.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Share-Term/share-term/issues"
+  },
+  "homepage": "https://github.com/Share-Term/share-term#readme",
+  "blah": {
+    "h_img": "http://i.imgur.com/AI9aB44.png"
   }
-}
+}