Skip to content

Commit

Permalink
docs: update readme to install from binary file
Browse files Browse the repository at this point in the history
  • Loading branch information
ntsd committed Oct 27, 2024
1 parent 9b3568b commit ac88872
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A multi device clipboard sharing over P2P network.
- Cross-platform desktop (Done) - support Windows, Linux, and Darwin (macOS).
- Cross-platform mobile (Ongoing) - support iOS and Android.

## Libraries
## Libraries

- [libp2p](https://github.com/libp2p/go-libp2p)
- [clipboard](https://github.com/golang-design/clipboard)
Expand All @@ -25,6 +25,17 @@ A multi device clipboard sharing over P2P network.

## Installation

### Homebrew tap install

```shell
brew tap ntsd/cross-clipboard
brew install cross-clipboard
```

### Binary File (MacOS, Windows, Linux)

Download from the release page <https://github.com/ntsd/cross-clipboard/releases>.

### Go install

for Go user you can just install using go package
Expand All @@ -35,13 +46,6 @@ Required: Go 1.23 or above
go install github.com/ntsd/cross-clipboard@latest
```

### Homebrew tap install

```shell
brew tap ntsd/cross-clipboard
brew install cross-clipboard
```

### Headless Linux

for headless linux you might need to install `xvfb`.
Expand Down

0 comments on commit ac88872

Please sign in to comment.