diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a8cdd23 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 dev6699 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..25053ae --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ + +#

RTERM

+ +RTERM is a web-based remote control application that allows you to control your terminal remotely. + +Inspired by [GoTTY](https://github.com/yudai/gotty) + +

+ +

+ + +## Installation + +- Grab the latest binary from the [releases](https://github.com/dev6699/rterm/releases) page. + + +- Or get the sources: + + 1. Clone the Repository: + ```bash + git clone https://github.com/dev6699/rterm.git + cd rterm + ``` + + 2. Build from source: + ```bash + make build + ``` + +## Usage +1. Start the binary `./rterm`. +2. Open web browser and navigate to `http://:5000`. +3. Get control of your terminal! + +## License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file diff --git a/rterm.gif b/rterm.gif new file mode 100644 index 0000000..8c6d4e1 Binary files /dev/null and b/rterm.gif differ