Skip to content

Commit

Permalink
⬆️ 2.1.0 🎉
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 10, 2020
1 parent 01ba258 commit 5d820c5
Show file tree
Hide file tree
Showing 3 changed files with 156 additions and 59 deletions.
209 changes: 153 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,72 @@
<!---------------------------------------------------------------------------->
<!-- 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! * * * -->
<!---------------------------------------------------------------------------->
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->








[![share-term](http://i.imgur.com/AI9aB44.png)](#)

# `$ share-term` [![Donate now][donate-now]][paypal-donations]

Share the terminal with your friends.

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:

## Installation






# `$ share-term`

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/share-term.svg)](https://www.npmjs.com/package/share-term) [![Downloads](https://img.shields.io/npm/dt/share-term.svg)](https://www.npmjs.com/package/share-term) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>







> Share the terminal with your friends.
















## :cloud: Installation

You can install the package globally and use it as command line tool:


```sh
$ npm i -g share-term
# Using npm
npm install --global share-term

# Using yarn
yarn global add share-term
```


Then, run `share-term --help` and see what the CLI tool can do.

```sh

```
$ share-term --help
share-term --help
Share the terminal with your friends.
Expand Down Expand Up @@ -66,52 +97,118 @@ Support Share Term now: http://share-term.me/support
```

## 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 `<id>` you have two ways:

1. Open the [Share Term website](http://share-term.me/) and enter your id there.
Then click the <kbd>Access</kbd> button. To request remote control click the
<kbd>🗼</kbd> 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 <id>
# With remote control
$ share-term get <id> -c
```

## Documentation















## :question: Get Help

There are few ways to get help:



1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:





## :memo: Documentation

For full API reference, see the [DOCUMENTATION.md][docs] file.

## How to contribute











## :yum: How to contribute
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:
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:


- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`

![](https://i.imgur.com/z6OQI95.png)


Thanks! :heart:
























## :scroll: License

[KINDLY][license] © [Ionică Bizău][website]





## License
[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
[license]: /LICENSE
[website]: undefined
[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
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
2 changes: 1 addition & 1 deletion lib/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Dependencies
var Pty = require("pty.js")
var Pty = require("node-pty")
, SocketIoClient = require("socket.io-client")
, Ul = require("ul")
, Open = require("open")
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "share-term",
"version": "2.0.2",
"version": "2.1.0",
"description": "Share the terminal with your friends.",
"main": "lib/index.js",
"bin": {
Expand All @@ -18,9 +18,9 @@
"bug-killer": "^4.0.0",
"cli-resize": "^1.0.0",
"ctrl-c": "^2.0.0",
"node-pty": "^0.9.0",
"oargv": "^2.0.0",
"open": "^0.0.5",
"pty.js": "^0.3.0",
"socket.io-client": "^1.3.7",
"ul": "^5.0.0"
},
Expand Down

0 comments on commit 5d820c5

Please sign in to comment.