coracle/coracle-rust
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Jon Staab
2026-04-14 13:50:54 -07:00
parent 1267477081
commit fe05d540d4
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8
View File
@@ -9,6 +9,11 @@ It has the following crates:
- `coracle-content` - Text parsing and rendering utilities - `coracle-content` - Text parsing and rendering utilities
- `coracle-storage` - Storage adapters for different platforms - `coracle-storage` - Storage adapters for different platforms
Platform bindings live in separate crates to keep the core library free of platform-specific annotations:
- `coracle-wasm` - Web bindings via `wasm-bindgen`, producing JS-friendly types
- `coracle-ffi` - C-compatible FFI via UniFFI, consumed by KMP (Kotlin Multiplatform)
All code is written in a [literate programming](https://en.wikipedia.org/wiki/Literate_programming) style and compiled to both html documentation and rust source code. The goal of this repository is threefold: All code is written in a [literate programming](https://en.wikipedia.org/wiki/Literate_programming) style and compiled to both html documentation and rust source code. The goal of this repository is threefold:
- To create a complete resource for learning how to work with the nostr protocol for humans - To create a complete resource for learning how to work with the nostr protocol for humans
@@ -73,6 +78,9 @@ coracle-tangle/ # The tangle/weave tool (Rust binary)
coracle-lib/ # Core nostr types and utilities (generated src/) coracle-lib/ # Core nostr types and utilities (generated src/)
coracle-net/ # Relay networking (generated src/) coracle-net/ # Relay networking (generated src/)
coracle-signer/ # Signing abstractions (generated src/) coracle-signer/ # Signing abstractions (generated src/)
coracle-domain/ # Domain-specific nostr types (generated src/)
coracle-content/ # Content parsing (generated src/) coracle-content/ # Content parsing (generated src/)
coracle-storage/ # Storage adapters (generated src/) coracle-storage/ # Storage adapters (generated src/)
coracle-wasm/ # Web bindings (wasm-bindgen)
coracle-ffi/ # C/KMP bindings (UniFFI)
``` ```