Skip to content

Commit fa500e1

Browse files
committed
docs: Update build notes with new CI installation steps
1 parent ce930cd commit fa500e1

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Usque is an open-source reimplementation of the Cloudflare WARP client's MASQUE
1010
- [🥚➡️🍏🍎](#️)
1111
- [Table of Contents](#table-of-contents)
1212
- [Installation](#installation)
13+
- [Building from source](#building-from-source)
1314
- [Docker](#docker)
1415
- [Usage](#usage)
1516
- [Registration](#registration)
@@ -40,7 +41,13 @@ Usque is an open-source reimplementation of the Cloudflare WARP client's MASQUE
4041

4142
## Installation
4243

43-
For now, this project is in the early research phase, so no CI or prebuilt binaries are available. You will need to build the project yourself. Since the tool is written in Go, it should be rather trivial.
44+
You can download the latest release from the [releases page](https://github.com/Diniboy1123/usque/releases). For now, Android (`arm64`), Linux (`armv5`, `armv6`, `armv7`, `arm64`, `amd64`) and Windows (`arm64`, `amd64`) binaries are provided. **However only the Linux `amd64` binary was tested.** If you have a different platform, you can build from source.
45+
46+
Extract the archive and you will find a binary named `usque` in the root directory. You can move this binary to a directory in your `PATH` to make it accessible from anywhere.
47+
48+
## Building from source
49+
50+
Since the tool is written in Go, it should be rather trivial.
4451

4552
1. Ensure that you have Go installed on your system. You can download it from [here](https://golang.org/dl/). At least Go 1.22 is required.
4653
2. Clone this repository and switch to the project's root directory

0 commit comments

Comments
 (0)