|
1 |
| -<!----------------------------------------------------------------------------> |
2 |
| -<!-- STOP, LOOK & LISTEN! --> |
3 |
| -<!-- ==================== --> |
4 |
| -<!-- Do NOT edit this file directly since it's generated from a template --> |
5 |
| -<!-- file, using https://github.com/IonicaBizau/node-blah --> |
6 |
| -<!-- --> |
7 |
| -<!-- If you found a typo in documentation, fix it in the source files --> |
8 |
| -<!-- (`lib/*.js`) and make a pull request. --> |
9 |
| -<!-- --> |
10 |
| -<!-- If you have any other ideas, open an issue. --> |
11 |
| -<!-- --> |
12 |
| -<!-- Please consider reading the contribution steps (CONTRIBUTING.md). --> |
13 |
| -<!-- * * * Thanks! * * * --> |
14 |
| -<!----------------------------------------------------------------------------> |
| 1 | +<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. --> |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | + |
15 | 9 |
|
16 | 10 | [](#)
|
17 | 11 |
|
18 |
| -# `$ share-term` [![Donate now][donate-now]][paypal-donations] |
19 | 12 |
|
20 |
| -Share the terminal with your friends. |
21 | 13 |
|
22 |
| -It's possible to share it into another terminal or in a browser, both with request |
23 |
| -control feature. |
24 | 14 |
|
25 |
| -If you enjoy using *Share Term*, [supporting it](http://share-term.me/support) |
26 |
| -would be really appreciated. :smile: :heart: |
27 | 15 |
|
28 |
| -## Installation |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | +# `$ share-term` |
| 23 | + |
| 24 | + [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/share-term) [](https://www.npmjs.com/package/share-term) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github) |
| 25 | + |
| 26 | +<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> |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | +> Share the terminal with your friends. |
| 35 | +
|
| 36 | + |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | + |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | +## :cloud: Installation |
29 | 53 |
|
30 | 54 | You can install the package globally and use it as command line tool:
|
31 | 55 |
|
| 56 | + |
32 | 57 | ```sh
|
33 |
| -$ npm i -g share-term |
| 58 | +# Using npm |
| 59 | +npm install --global share-term |
| 60 | + |
| 61 | +# Using yarn |
| 62 | +yarn global add share-term |
34 | 63 | ```
|
35 | 64 |
|
| 65 | + |
36 | 66 | Then, run `share-term --help` and see what the CLI tool can do.
|
37 | 67 |
|
38 |
| -```sh |
| 68 | + |
| 69 | +``` |
39 | 70 | $ share-term --help
|
40 | 71 | share-term --help
|
41 | 72 | Share the terminal with your friends.
|
@@ -66,52 +97,118 @@ Support Share Term now: http://share-term.me/support
|
66 | 97 |
|
67 | 98 | ```
|
68 | 99 |
|
69 |
| -## Usage |
70 |
| -### :earth_africa: Sharing the terminal |
71 |
| -To share your terminal do: |
72 | 100 |
|
73 |
| -```sh |
74 |
| -$ share-term |
75 |
| -``` |
76 | 101 |
|
77 |
| -You will get a session id which you will send to your friends. |
78 | 102 |
|
79 |
| -### :tokyo_tower: Accessing a session |
80 |
| -To join a terminal session, having the id `<id>` you have two ways: |
81 | 103 |
|
82 |
| - 1. Open the [Share Term website](http://share-term.me/) and enter your id there. |
83 |
| - Then click the <kbd>Access</kbd> button. To request remote control click the |
84 |
| - <kbd>🗼</kbd> button in the right bottom side. |
85 |
| - 2. Having `share-term` installed on your computer (see [Installation](#Installation)) |
86 |
| - you can join the session using: |
87 | 104 |
|
88 |
| - ```sh |
89 |
| - # Without remote control |
90 |
| - $ share-term get <id> |
91 |
| - # With remote control |
92 |
| - $ share-term get <id> -c |
93 |
| - ``` |
94 | 105 |
|
95 |
| -## Documentation |
| 106 | + |
| 107 | + |
| 108 | + |
| 109 | + |
| 110 | + |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | + |
| 115 | + |
| 116 | + |
| 117 | + |
| 118 | + |
| 119 | + |
| 120 | + |
| 121 | +## :question: Get Help |
| 122 | + |
| 123 | +There are few ways to get help: |
| 124 | + |
| 125 | + |
| 126 | + |
| 127 | + 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. |
| 128 | + 2. For bug reports and feature requests, open issues. :bug: |
| 129 | + 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: |
| 130 | + |
| 131 | + |
| 132 | + |
| 133 | + |
| 134 | + |
| 135 | +## :memo: Documentation |
96 | 136 |
|
97 | 137 | For full API reference, see the [DOCUMENTATION.md][docs] file.
|
98 | 138 |
|
99 |
| -## How to contribute |
| 139 | + |
| 140 | + |
| 141 | + |
| 142 | + |
| 143 | + |
| 144 | + |
| 145 | + |
| 146 | + |
| 147 | + |
| 148 | + |
| 149 | + |
| 150 | +## :yum: How to contribute |
100 | 151 | Have an idea? Found a bug? See [how to contribute][contributing].
|
101 | 152 |
|
102 |
| -## Press Highlights |
103 |
| -None yet. If you wrote or found an article about this project, [add it][contributing] in this section. :memo: |
104 | 153 |
|
105 |
| -## Who uses this |
106 |
| -If you are using this library in one of your projects, add it in this list. :sparkles: |
| 154 | +## :sparkling_heart: Support my projects |
| 155 | +I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, |
| 156 | +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). |
| 157 | + |
| 158 | +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: |
| 159 | + |
| 160 | + |
| 161 | + - Starring and sharing the projects you like :rocket: |
| 162 | + - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: |
| 163 | + - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: |
| 164 | + - [![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). |
| 165 | + - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6` |
| 166 | + |
| 167 | +  |
| 168 | + |
| 169 | + |
| 170 | +Thanks! :heart: |
| 171 | + |
| 172 | + |
| 173 | + |
| 174 | + |
| 175 | + |
| 176 | + |
| 177 | + |
| 178 | + |
| 179 | + |
| 180 | + |
| 181 | + |
| 182 | + |
| 183 | + |
| 184 | + |
| 185 | + |
| 186 | + |
| 187 | + |
| 188 | + |
| 189 | + |
| 190 | + |
| 191 | + |
| 192 | + |
| 193 | + |
| 194 | + |
| 195 | +## :scroll: License |
| 196 | + |
| 197 | +[KINDLY][license] © [Ionică Bizău][website] |
| 198 | + |
| 199 | + |
| 200 | + |
| 201 | + |
107 | 202 |
|
108 |
| -## License |
109 |
| -[KINDLY][license] © [Ionică Bizău][website]–The [LICENSE](/LICENSE) file contains |
110 |
| -a copy of the license. |
111 | 203 |
|
112 |
| -[license]: http://ionicabizau.github.io/kindly-license/ ?author=Ionic%C4%83%20Biz%C4%83u%20% [email protected]%3E &year=2015 |
| 204 | +[license]: /LICENSE |
| 205 | +[website]: undefined |
113 | 206 | [contributing]: /CONTRIBUTING.md
|
114 |
| -[website]: http://ionicabizau.net |
115 | 207 | [docs]: /DOCUMENTATION.md
|
116 |
| -[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MG98D7NPFZ3MG |
117 |
| -[donate-now]: http://i.imgur.com/6cMbHOC.png |
| 208 | +[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg |
| 209 | +[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg |
| 210 | +[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg |
| 211 | +[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg |
| 212 | +[patreon]: https://www.patreon.com/ionicabizau |
| 213 | +[amazon]: http://amzn.eu/hRo9sIZ |
| 214 | +[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW |
0 commit comments