docs: add crates.io badges and install instructions to ruv-neural README
Add version badges linking to each published crate on crates.io, cargo add instructions, and crate search link in the Crate Map table. Co-Authored-By: claude-flow <ruv@ruv.net>
This commit is contained in:
parent
614d242967
commit
17de6885de
|
|
@ -2,6 +2,7 @@
|
|||
|
||||
> Quantum sensor integration x RuVector graph memory x Dynamic mincut coherence detection
|
||||
|
||||
[](https://crates.io/crates/ruv-neural-core)
|
||||
[]()
|
||||
[]()
|
||||
[]()
|
||||
|
|
@ -168,20 +169,22 @@ vendor will work.
|
|||
|
||||
## Crate Map
|
||||
|
||||
| Crate | Description | Dependencies |
|
||||
|-------|-------------|--------------|
|
||||
| `ruv-neural-core` | Core types, traits, errors, RVF format | None |
|
||||
| `ruv-neural-sensor` | NV diamond, OPM, EEG sensor interfaces | core |
|
||||
| `ruv-neural-signal` | DSP: filtering, spectral, connectivity | core |
|
||||
| `ruv-neural-graph` | Brain connectivity graph construction | core, signal |
|
||||
| `ruv-neural-mincut` | Dynamic minimum cut topology analysis | core |
|
||||
| `ruv-neural-embed` | RuVector graph embeddings | core |
|
||||
| `ruv-neural-memory` | Persistent neural state memory + HNSW | core, embed |
|
||||
| `ruv-neural-decoder` | Cognitive state classification + BCI | core, embed |
|
||||
| `ruv-neural-esp32` | ESP32 edge sensor integration | core |
|
||||
| `ruv-neural-wasm` | WebAssembly browser bindings | core |
|
||||
| `ruv-neural-viz` | Visualization and ASCII rendering | core, graph |
|
||||
| `ruv-neural-cli` | CLI tool (`ruv-neural` binary) | all |
|
||||
All crates are published on [crates.io](https://crates.io/search?q=ruv-neural):
|
||||
|
||||
| Crate | crates.io | Description | Dependencies |
|
||||
|-------|-----------|-------------|--------------|
|
||||
| [`ruv-neural-core`](https://crates.io/crates/ruv-neural-core) | [](https://crates.io/crates/ruv-neural-core) | Core types, traits, errors, RVF format | None |
|
||||
| [`ruv-neural-sensor`](https://crates.io/crates/ruv-neural-sensor) | [](https://crates.io/crates/ruv-neural-sensor) | NV diamond, OPM, EEG sensor interfaces | core |
|
||||
| [`ruv-neural-signal`](https://crates.io/crates/ruv-neural-signal) | [](https://crates.io/crates/ruv-neural-signal) | DSP: filtering, spectral, connectivity | core |
|
||||
| [`ruv-neural-graph`](https://crates.io/crates/ruv-neural-graph) | [](https://crates.io/crates/ruv-neural-graph) | Brain connectivity graph construction | core, signal |
|
||||
| [`ruv-neural-mincut`](https://crates.io/crates/ruv-neural-mincut) | [](https://crates.io/crates/ruv-neural-mincut) | Dynamic minimum cut topology analysis | core |
|
||||
| [`ruv-neural-embed`](https://crates.io/crates/ruv-neural-embed) | [](https://crates.io/crates/ruv-neural-embed) | RuVector graph embeddings | core |
|
||||
| [`ruv-neural-memory`](https://crates.io/crates/ruv-neural-memory) | [](https://crates.io/crates/ruv-neural-memory) | Persistent neural state memory + HNSW | core |
|
||||
| [`ruv-neural-decoder`](https://crates.io/crates/ruv-neural-decoder) | [](https://crates.io/crates/ruv-neural-decoder) | Cognitive state classification + BCI | core |
|
||||
| [`ruv-neural-esp32`](https://crates.io/crates/ruv-neural-esp32) | [](https://crates.io/crates/ruv-neural-esp32) | ESP32 edge sensor integration | core |
|
||||
| `ruv-neural-wasm` | — | WebAssembly browser bindings | core |
|
||||
| [`ruv-neural-viz`](https://crates.io/crates/ruv-neural-viz) | [](https://crates.io/crates/ruv-neural-viz) | Visualization and ASCII rendering | core, graph, mincut |
|
||||
| [`ruv-neural-cli`](https://crates.io/crates/ruv-neural-cli) | [](https://crates.io/crates/ruv-neural-cli) | CLI tool (`ruv-neural` binary) | all |
|
||||
|
||||
## Dependency Graph
|
||||
|
||||
|
|
@ -224,6 +227,23 @@ cargo run -p ruv-neural-cli -- pipeline --channels 32 --duration 5 --dashboard
|
|||
cargo run -p ruv-neural-cli -- mincut --input brain_graph.json
|
||||
```
|
||||
|
||||
### Install from crates.io
|
||||
|
||||
```bash
|
||||
# Add individual crates as needed
|
||||
cargo add ruv-neural-core
|
||||
cargo add ruv-neural-sensor
|
||||
cargo add ruv-neural-signal
|
||||
cargo add ruv-neural-mincut
|
||||
cargo add ruv-neural-embed
|
||||
cargo add ruv-neural-memory
|
||||
cargo add ruv-neural-decoder
|
||||
cargo add ruv-neural-graph
|
||||
cargo add ruv-neural-viz
|
||||
cargo add ruv-neural-esp32
|
||||
cargo add ruv-neural-cli
|
||||
```
|
||||
|
||||
### Use as Library
|
||||
|
||||
```rust
|
||||
|
|
|
|||
Loading…
Reference in New Issue