Skip to content

Commit 7872bdf

Browse files
committed
Update README
1 parent 8e0c7a1 commit 7872bdf

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,40 @@
22

33
Unlike most command-line tools for web services that require an API, Terminalwire streams terminal I/O between a web server and client over WebSockets. This means you can use your preferred command-line parser within your favorite web server framework to deliver a delightful CLI experience to your users.
44

5+
## What's in this repo?
6+
7+
This is a monolithic repository with several Terminalwire components, including the Terminalwire thin-client and Ruby & Rails servers.
8+
9+
### Terminalwire Client
10+
11+
The Terminalwire thin-client is pacakged using Tebako and is installed on end-user workstations. The thin-client connects to a Terminalwire server and streams stdio, browser, filesystem, and other commands between the server and client via WebSockets through an entitlement-based security layer.
12+
13+
[Read the Terminalwire-client manual](https://terminalwire.com/docs/client)
14+
15+
### Terminalwire Ruby & Rails servers
16+
17+
Terminalwire servers can run on any platform or framework. This repo has source for the Ruby Terminalwire server, specifically targeting Ruby on Rails.
18+
19+
[Read the Terminalwire Ruby on Rails manual](https://terminalwire.com/docs/rails)
20+
521
## Installation
622

7-
Install the gem and add to the application's Gemfile by executing:
23+
### Client
24+
25+
The Terminalwire thin-client may be installed by running:
826

9-
$ bundle add terminalwire
27+
$ curl -sSL https://terminalwire.sh/ | bash
1028

11-
If bundler is not being used to manage dependencies, install the gem by executing:
29+
This installs the Tebako packaged version of the Terminalwire client, which is recommended for production use.
30+
31+
#### RubyGem client
32+
33+
The Terminalwire thin-client gem may be installed for development purposes by running:
1234

1335
$ gem install terminalwire
1436

37+
*This approach is not recommended for production use since developer workstations likely don't have the correct Ruby dependencies installed*
38+
1539
## Rails
1640

1741
Run the intallation command:
@@ -38,7 +62,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/termin
3862

3963
## License
4064

41-
The gem is available as a propietary license. Email [email protected] to discuss licensing.
65+
The gem is available as a propietary license. The tl;dr is that it's free for personal use and for commercial use email [email protected] to discuss licensing.
4266

4367
## Code of Conduct
4468

0 commit comments

Comments
 (0)