commit 61702057c0837146fc6dc1c1b6d62e8dd25695e9
parent 174104cd2c7a4a90fe1c9a2af2a202db51d36f07
Author: triesap <tyson@radroots.org>
Date: Thu, 30 Jul 2026 22:01:54 +0000
docs: update README.md
Diffstat:
| D | README | | | 29 | ----------------------------- |
| A | README.md | | | 120 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 120 insertions(+), 29 deletions(-)
diff --git a/README b/README
@@ -1,29 +0,0 @@
-# »-`-,-
-
-This is the README for `radroots` core libraries, which together constitute a
-composable architecture for coordinating local agricultural networks.
-
-## Getting Rad Roots
-
-The preferred method to download `radroots` source code is to use git.
-
-To download `radroots` do the following:
-
- git clone https://radroots.dev/git/lib.git
-
-If you have questions about `radroots` or if you wish to be notified of releases,
-you can browse and/or join the `radroots` mailing list:
-
- https://radroots.dev/lists/listinfo
-
-Rad Roots is built on Love for the Planet and its People.
-
-## Copyright
-
-Except as otherwise noted, all files in the `radroots` distribution are
-
- Copyright (c) 2025 Tyson Lupul
-
-## License
-
-This repository is licensed under either MIT or Apache-2.0, at your option. See LICENSE-MIT and LICENSE-APACHE.
diff --git a/README.md b/README.md
@@ -0,0 +1,120 @@
+
+
+Build local food networks that help farms and communities organize and communicate.
+
+**What it does:** Radroots specifies the event and networking foundations for building interoperable local food networks, where governance and data ownership remain in the hands of the communities that run them.
+
+**[Install](https://radroots.dev/docs/install)**
+| [Docs](https://radroots.dev/docs)
+| [Examples](https://radroots.dev/docs/examples)
+| [Releases](https://radroots.dev/downloads/)
+
+### Use cases
+- Farmers post what they are growing and receive orders for upcoming harvests
+- Food hubs organize group buying across farms, households and local businesses
+- Farms and food hubs schedule drops and market days where buyers pick up orders
+- Restaurants and local businesses arrange regular orders directly with nearby farms
+- Local couriers carry orders from farms to homes, businesses and pickup points
+
+### How to use
+```rust
+use radroots::prelude::*;
+
+let client = Client::builder()
+ .signer(signer)
+ .transport(Nostr::relays(["wss://radroots.org"])?)
+ .build()
+ .await?;
+
+let farm = client
+ .seller(seller_account)?
+ .farm(farm_id)?;
+
+// Farmer creates a listing for freshly picked tomatoes
+let receipt = farm
+ .listings()
+ .publish("Heirloom tomatoes")
+ .id("fresh-tomatoes")
+ .description("Locally grown and picked this morning.")
+ .price(Price::cad_per_kg(4)?)
+ .available(Quantity::kg(20)?)
+ .pickup_in(Locality::city("Victoria", "BC", "CA")?)
+ .send() // Validates, signs, saves locally, and attempts publication
+ .await?;
+
+// Log the published event address
+println!("Published: {}", receipt.address());
+…
+```
+
+### Getting started
+
+> **Status:** Alpha (`0.1.0-alpha`)
+> Still a `draft`. Not recommended for use before `0.1.0` is published.
+
+The Radroots libraries are a Rust workspace with a small set of native build dependencies. Nix is recommended; the manual setup below covers the minimum requirements on macOS and Linux. See [`BUILD.md`](BUILD.md) for the complete build guide.
+
+#### Nix (*recommended*)
+
+The Nix development shell provides a configured environment on macOS and Linux:
+
+```sh
+git clone https://radroots.dev/git/lib.git && cd lib
+
+nix develop
+cargo check --workspace --locked
+```
+
+#### macOS and Linux
+
+To setup manually, install [Rust](https://rustup.rs/), Git, LLVM/Clang with `libclang`, `pkg-config`, and `libsodium`.
+
+On macOS with Homebrew:
+
+```sh
+brew install llvm pkgconf libsodium
+export LIBCLANG_PATH="$(brew --prefix llvm)/lib"
+```
+
+On Debian or Ubuntu:
+
+```sh
+sudo apt install build-essential clang libclang-dev pkg-config libsodium-dev
+```
+
+Then clone and check the workspace:
+
+```sh
+git clone https://radroots.dev/git/lib.git && cd lib
+
+export SODIUM_USE_PKG_CONFIG=1
+cargo check --workspace --locked
+```
+
+On macOS, if `bindgen` cannot locate the system headers:
+
+```sh
+export SDKROOT="$(xcrun --sdk macosx --show-sdk-path)"
+export BINDGEN_EXTRA_CLANG_ARGS="--sysroot=${SDKROOT}"
+```
+
+#### SP1 (*optional*)
+
+SP1 is required to compile programs and generate proofs. Install Protocol Buffers and the SP1 toolchain:
+
+```sh
+# macOS
+brew install protobuf
+
+# Debian or Ubuntu
+sudo apt install protobuf-compiler
+
+curl -L https://sp1up.succinct.xyz | bash
+sp1up
+```
+
+Run proof generation in release mode. CUDA proving is supported on compatible Linux systems, not on macOS. See [`BUILD.md`](BUILD.md) for the complete setup.
+
+## Status
+
+Radroots is under active development. The API is not yet stable and will change quite often.
