mirror of
https://github.com/logos-storage/logos-storage-go-bindings-example.git
synced 2026-01-02 13:33:12 +00:00
Update the README
This commit is contained in:
parent
e4a2a48059
commit
af40887c76
24
README.md
24
README.md
@ -2,7 +2,7 @@
|
||||
|
||||
This repository demonstrates how to integrate the [Codex Go bindings](https://github.com/codex-storage/codex-go-bindings) into a Go project.
|
||||
|
||||
The project starts a Codex node, uploads and downloads some data, and can be stopped with `Ctrl+C`.
|
||||
The project starts a Codex node, uploads and downloads some data and then stops the node.
|
||||
|
||||
## Usage
|
||||
|
||||
@ -19,13 +19,19 @@ make fetch
|
||||
```
|
||||
|
||||
The default `OS` is `linux` and the default `ARCH` is `amd64`.
|
||||
You can update them like this:
|
||||
You can provide them as environment variables:
|
||||
|
||||
```sh
|
||||
OS="macos" ARCH="arm64" make fetch
|
||||
```
|
||||
|
||||
By default, the last release will be downloaded and extracted to libs folder.
|
||||
You can change the version by providing it as environment variables:
|
||||
|
||||
```sh
|
||||
VERSION="v0.0.21" make fetch
|
||||
```
|
||||
|
||||
The default folder is `libs`, you can change it by editing the `Makefile`.
|
||||
|
||||
### Build
|
||||
|
||||
@ -36,5 +42,15 @@ make build
|
||||
### Run
|
||||
|
||||
```sh
|
||||
./example
|
||||
make run
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
To run on Windows, you need to include the `libs` folder (or your custom folder if you changed it) into the path:
|
||||
|
||||
|
||||
```powershell
|
||||
$env:PATH = "$PWD\libs;" + $env:PATH
|
||||
.\example.exe
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user