Skip to content

Commit

Permalink
docs(readme): update quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
savioxavier committed Jun 12, 2023
1 parent 93b7dcf commit b8cc382
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ func main() {
}
```

- You can also use this package in combination with another popular Go package [fatih/color](https://github.com/fatih/color)
- Since `termlink.Link` returns a string, you can use it with your favorite text color formatting libraries such as [fatih/color](https://github.com/fatih/color), [mgutz/ansi](https://github.com/mgutz/ansi), etc. Alternatively, you can use `termlink.ColorLink` as well.

```go
import (
Expand All @@ -67,7 +67,7 @@ import (

func main() {
// With fatih/color package
color.Cyan(termlink.Link("Example link using the colors package", "https://example.com"))
color.Cyan(termlink.Link("Example link using the fatih/color package", "https://example.com"))
}
```

Expand All @@ -81,6 +81,15 @@ func main() {

More examples can be found in the [`examples/`](examples/) directory.

For a quick start, execute the following in your terminal

```bash
git clone https://github.com/savioxavier/termlink.git
cd termlink/
go get github.com/savioxavier/termlink
go run examples/start.go
```

---

## 🔮 Features
Expand Down

0 comments on commit b8cc382

Please sign in to comment.