From af40887c76aa5a8e8e2f402642c035dc248c9419 Mon Sep 17 00:00:00 2001 From: Arnaud Date: Thu, 16 Oct 2025 07:23:38 +0200 Subject: [PATCH] Update the README --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 73ba574..2bfe0aa 100644 --- a/README.md +++ b/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 ``` \ No newline at end of file