diff --git a/.blah/README.ejs b/.blah/README.ejs deleted file mode 100644 index caaf8ab..0000000 --- a/.blah/README.ejs +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - - - - - - - - - - - -<% // Dependencies %> -<% var IsThere = require("is-there"); %> -<% var Fs = require("fs"); %> -<% var Path = require("path"); %> -<% var Ul = require("ul"); %> -<% var ExecSync = require("child_process").execSync; %> - -<% // Compute the directory paths %> -<% var binPath = Path.join(_.path, "bin"); %> -<% var examplesPath = Path.join(_.path, "examples"); %> -<% var examplePath = Path.join(_.path, "example"); %> -<% var example = IsThere(examplePath) ? examplePath : IsThere(examplesPath) ? examplesPath : null; %> -<% var isWeb = IsThere(examplePath + "/index.html"); %> -<% var isOnlyWeb = IsThere(process.cwd() + "/index.html"); %> -<% isWeb = isWeb || isOnlyWeb; %> -<% var isCli = IsThere(binPath); %> - -<% if (_.pack.blah.h_img) { %> -[![<%- _.pack.name %>](<%- _.pack.blah.h_img %>)](<%-_.pack.blah.h_url || "#"%>) -<% } %> - -<% // Create the name and description %> -<% if (isCli) { %> -# `$ <%- _.pack.name %>` [![Donate now][donate-now]][paypal-donations] -<% } else { %> -# <%- _.pack.blah.title || _.pack.name %> [![Donate now][donate-now]][paypal-donations] -<% } %> -<%- _.pack.description %> - -<%- _.pack.blah.description %> - -It's possible to share it into another terminal or in a browser, both with request -control feature. - -If you enjoy using *Share Term*, [supporting it](http://share-term.me/support) -would be really appreciated. :smile: :heart: - -<% if (_.pack.blah.ex_img) { %> -[![<%- _.pack.name %>](<%- _.pack.blah.ex_img %>)](<%-_.pack.blah.ex_url || "#"%>) -<% } %> - -<% // INSTALLATION %> -<% if (!isOnlyWeb) { %> -## Installation -<% } %> -<% // Cli usage %> -<% if (isCli) { %> -You can install the package globally and use it as command line tool: - -```sh -$ npm i -g <%- _.pack.name %> -``` - -Then, run `<%- _.pack.name %> --help` and see what the CLI tool can do. - -<% if (_.pack.bin) { %> -<% var cliCommand = Object.keys(_.pack.bin) %> -<% var cliPath = _.pack.bin[cliCommand] %> -<% } %> -<% if (IsThere(cliPath)) { %> -```sh -$ <%- cliCommand %> --help -<%- ExecSync(cliPath + " --help", { cwd: process.cwd() }).toString().slice(0, -1) %> -``` -<% } %> - -<% } else if (isWeb) { %> -<% if (!isOnlyWeb) { %> -Check out the [`dist`](/dist) directory to download the script and include into your page. -<% } %> -<% } else { %> - -```sh -$ npm i <%- _.pack.name %> -``` - -<% } %> - -## Usage -### :earth_africa: Sharing the terminal -To share your terminal do: - -```sh -$ share-term -``` - -You will get a session id which you will send to your friends. - -### :tokyo_tower: Accessing a session -To join a terminal session, having the id `` you have two ways: - - 1. Open the [Share Term website](http://share-term.me/) and enter your id there. - Then click the Access button. To request remote control click the - 🗼 button in the right bottom side. - 2. Having `share-term` installed on your computer (see [Installation](#Installation)) - you can join the session using: - - ```sh - # Without remote control - $ share-term get - # With remote control - $ share-term get -c - ``` - - - -<% // Show the example if there is one %> -<% if (example) { %> -<% var exStrPath = Path.join(example, "index.js"); %> -<% if (!IsThere(exStrPath)) { %> -<% example = null; %> -<% } %> -<% if (example) { %> -## Example - -<% if (isCli) { %> -Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm`: - -```sh -$ npm i <%- _.pack.name %> -``` - -<% } %> - -<% var exStr = Fs.readFileSync(exStrPath, "utf-8"); %> -<% exStr = exStr.replace("../lib", _.pack.name) %> - -```js -<%- exStr %> -``` -<% } %> -<% } %> - - -<% // Documentation %> -<% if (!isOnlyWeb) { %> -## Documentation - -<% if (isCli) { %> -For full API reference, see the [DOCUMENTATION.md][docs] file. -<% } else { %> -<% docs = docs.split("\n").slice(3).join("\n"); %> -<%- docs %> -<% } %> -<% } %> - -<% // How to contribute %> -## How to contribute -Have an idea? Found a bug? See [how to contribute][contributing]. - -<% // Thanks %> -<% if (_.pack.blah.thanks) { %> -## Thanks -<% for (var k in _.pack.blah.thanks) { %> - - <%-_.pack.blah.thanks[k]%> -<% } %> -<% } %> - -## Press Highlights -None yet. If you wrote or found an article about this project, [add it][contributing] in this section. :memo: - -<% if (!isOnlyWeb) { %> -## Who uses this -If you are using this library in one of your projects, add it in this list. :sparkles: -<% } %> - -<% // Who used this? %> -<% if (_.pack.blah.usages) { %> -<% for (var k in _.pack.blah.usages) { %> - - [<%-_.pack.blah.usages[k].name%>](<%-_.pack.blah.usages[k].url%>) -<% } %> -<% } %> - -<% // License information %> -## License -[KINDLY][license] © [Ionică Bizău][website]–The [LICENSE](/LICENSE) file contains -a copy of the license. - -<% // Links %> -[license]: http://ionicabizau.github.io/kindly-license/?author=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica@gmail.com%3E&year=<%- new Date().getFullYear() %> -[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 diff --git a/package.json b/package.json index cd13efe..a6421a1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "share-term", - "version": "2.0.1", + "version": "2.0.2", "description": "Share the terminal with your friends.", "main": "lib/index.js", "bin": {