Skip to content

Commit bef4f79

Browse files
committed
chore(docs): updated readme
1 parent c33e021 commit bef4f79

1 file changed

Lines changed: 20 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# superstac
22

33
[![License](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
4+
[![crates.io](https://img.shields.io/crates/v/superstac-search.svg)](https://crates.io/crates/superstac-search)
5+
[![docs.rs](https://docs.rs/superstac-core/badge.svg)](https://docs.rs/superstac-search)
46

57
Federated [STAC](https://stacspec.org/) search across multiple catalogs. Query
68
Element84, Microsoft Planetary Computer, and others through one API.
@@ -24,16 +26,25 @@ timeouts, then merges and dedupes the results.
2426

2527
## Install
2628

27-
There is no published binary yet. Build from source:
29+
### Rust library
30+
31+
Add the crates you need:
32+
33+
```bash
34+
cargo add superstac-core
35+
cargo add superstac-search
36+
cargo add superstac-engine
37+
cargo add superstac-cli
38+
cargo add superstac-config
39+
```
40+
41+
### From source
2842

2943
```bash
3044
git clone https://github.com/spatialnode/superstac
3145
cd superstac
3246
cargo build --release
3347
```
34-
35-
The CLI binary lands at `target/release/superstac`.
36-
3748
## Quickstart
3849

3950
Drop a `superstac.yml` next to where you run the binary:
@@ -131,11 +142,11 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
131142

132143
| Crate | Purpose |
133144
|-------|---------|
134-
| [`superstac-core`](./crates/core) | domain models, errors, storage trait |
135-
| [`superstac-config`](./crates/config) | YAML config loading |
136-
| [`superstac-search`](./crates/search) | federated search logic |
137-
| [`superstac-engine`](./crates/engine) | runtime (health, introspection, search orchestration) |
138-
| [`superstac-cli`](./crates/cli) | the `superstac` binary |
145+
| [`superstac-core`](https://crates.io/crates/superstac-core) | domain models, errors, storage trait |
146+
| [`superstac-config`](https://crates.io/crates/superstac-config) | YAML config loading |
147+
| [`superstac-search`](https://crates.io/crates/superstac-search) | federated search logic |
148+
| [`superstac-engine`](https://crates.io/crates/superstac-engine) | runtime (health, introspection, search orchestration) |
149+
| [`superstac-cli`](https://crates.io/crates/superstac-cli) | the `superstac` binary |
139150

140151
## Logs and debugging
141152

0 commit comments

Comments
 (0)