Skip to content

Commit af40887

Browse files
committed
Update the README
1 parent e4a2a48 commit af40887

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repository demonstrates how to integrate the [Codex Go bindings](https://github.com/codex-storage/codex-go-bindings) into a Go project.
44

5-
The project starts a Codex node, uploads and downloads some data, and can be stopped with `Ctrl+C`.
5+
The project starts a Codex node, uploads and downloads some data and then stops the node.
66

77
## Usage
88

@@ -19,13 +19,19 @@ make fetch
1919
```
2020

2121
The default `OS` is `linux` and the default `ARCH` is `amd64`.
22-
You can update them like this:
22+
You can provide them as environment variables:
2323

2424
```sh
2525
OS="macos" ARCH="arm64" make fetch
2626
```
2727

28-
By default, the last release will be downloaded and extracted to libs folder.
28+
You can change the version by providing it as environment variables:
29+
30+
```sh
31+
VERSION="v0.0.21" make fetch
32+
```
33+
34+
The default folder is `libs`, you can change it by editing the `Makefile`.
2935

3036
### Build
3137

@@ -36,5 +42,15 @@ make build
3642
### Run
3743

3844
```sh
39-
./example
45+
make run
46+
```
47+
48+
### Windows
49+
50+
To run on Windows, you need to include the `libs` folder (or your custom folder if you changed it) into the path:
51+
52+
53+
```powershell
54+
$env:PATH = "$PWD\libs;" + $env:PATH
55+
.\example.exe
4056
```

0 commit comments

Comments
 (0)