Where do I find the docs?

[IngwiePhoenix]

Hello and good day!

Describe the enhancement
I am mainly familiar with C, JS, PHP and a few other languages in this particular circle - so Rust is rather new to me. But, I still want to write a nostr app that uses this library together with SurrealDB. However, I couldn't find the docs to this library, at all. o.o

Use case
Newcomers like me might be looking at the readme or crates.io page and wonder how they actually use it and what each of the sub-crates and stuff provide. So just having a link to the docs in a very obvious spot would be neat and helpful. :)

Additional context
There are many projects I will be working on that I am likely writing in Rust. So some docs would be much appreciated. :)

Thank you for your hard work!

Kind regards,
Ingwie

[yukibtc]

Hey, for now are available only the rust docs (auto generated) and the examples. I started to write also a book (both for Rust and bindings) but will require time.

You can find the docs and examples here:

• nostr:

  • docs: https://docs.rs/nostr/0.25.0/nostr/
  • examples: https://github.com/rust-nostr/nostr/tree/master/crates/nostr/examples

• nostr-sdk:

  • docs: https://docs.rs/nostr-sdk/0.25.0/nostr_sdk/
  • examples: https://github.com/rust-nostr/nostr/tree/master/crates/nostr-sdk/examples

[yukibtc]

#173 and #186