Skip to content

Commit

Permalink
docs: Release v0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dev6699 committed May 18, 2024
1 parent 5299d71 commit 0e894fe
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 11 deletions.
61 changes: 50 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[![GoDoc](https://pkg.go.dev/badge/github.com/dev6699/rterm)](https://pkg.go.dev/github.com/dev6699/rterm)
[![Go Report Card](https://goreportcard.com/badge/github.com/dev6699/rterm)](https://goreportcard.com/report/github.com/dev6699/rterm)
[![License](https://img.shields.io/github/license/dev6699/rterm)](LICENSE)

# <p align="center">RTERM</p>

Expand All @@ -12,21 +15,57 @@ Inspired by [GoTTY](https://github.com/yudai/gotty)

## Installation

- Grab the latest binary from the [releases](https://github.com/dev6699/rterm/releases) page.
1. Import as package to exisitng project.
```bash
go get github.com/dev6699/rterm
```

```go
import (
"github.com/dev6699/rterm"
"github.com/dev6699/rterm/command"
)
- Or get the sources:
func main() {
rterm.SetPrefix("/")
mux := http.NewServeMux()
1. Clone the Repository:
```bash
git clone https://github.com/dev6699/rterm.git
cd rterm
```
rterm.Register(
mux,
rterm.Command{
Factory: func() (*command.Command, error) {
return command.New("bash", nil)
},
Name: "bash",
Description: "Bash (Unix shell)",
Writable: true,
},
)
2. Build from source:
```bash
make build
```
addr := ":5000"
server := &http.Server{
Addr: addr,
Handler: mux,
}
server.ListenAndServe()
}
```
Please check [example](cmd/rterm/main.go) for more information.
<img src="screenshot.png">

2. Prebuilt binary.

- Grab the latest binary from the [releases](https://github.com/dev6699/rterm/releases) page.

3. From sources:
```bash
# Clone the Repository
git clone https://github.com/dev6699/rterm.git
cd rterm
# Build
make build
```

## Usage
1. Start the binary `./rterm`.
Expand Down
7 changes: 7 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Release 0.2.0
## Major Features and Improvements
* Add support to integrate with existing http server.
* Add support for multiple commands

# Release 0.1.0
Initial release of rterm.
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0e894fe

Please sign in to comment.