expand nostrdb-rs docs, add mdbook #54
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
e7b92a9Rebuild the README with requirements/quickstart instructions, linkinto the nostrdb mdBook, add a Rust-specific guide (
docs/rust.md), and shipa sample event fixture for examples/tests.
48deb93Pull the README into crate-level docs and annotate the public APIsurface (
Config,Filter,Ndb,Note, etc.) with module/type docs thatreference the mdBook chapters.
6227e92Add runnableingest,query, andsubscriptionexamples thatmirror the CLI workflows so users can exercise the Rust bindings end-to-end.