book: rework sections

Signed-off-by: Yuki Kishimoto <[email protected]>
rust-nostr · Nov 18, 2024 · dca87da · dca87da
1 parent 1cec130
commit dca87da
Show file tree

Hide file tree

Showing 140 changed files with 862 additions and 918 deletions.
diff --git a/bindings/nostr-sdk-ffi/python/examples/metadata.py b/bindings/nostr-sdk-ffi/python/examples/metadata.py
@@ -19,7 +19,7 @@ async def main():
         .set_picture("https://example.com/avatar.png") \
         .set_banner("https://example.com/banner.png") \
         .set_nip05("[email protected]") \
-        .set_lud16("yuki@getalby.com")
+        .set_lud16("pay@yukikishimoto.com")
 
     print(f"Setting profile metadata for {keys.public_key().to_bech32()}...")
     print(metadata.as_json())

diff --git a/bindings/nostr-sdk-js/README.md b/bindings/nostr-sdk-js/README.md
@@ -45,7 +45,7 @@ async function main() {
         .picture("https://example.com/avatar.png")
         .banner("https://example.com/banner.png")
         .nip05("[email protected]")
-        .lud16("yuki@getalby.com");
+        .lud16("pay@yukikishimoto.com");
 
     await client.setMetadata(metadata);
 

diff --git a/bindings/nostr-sdk-js/examples/client.js b/bindings/nostr-sdk-js/examples/client.js
@@ -32,7 +32,7 @@ async function main() {
         .picture("https://example.com/avatar.png")
         .banner("https://example.com/banner.png")
         .nip05("[email protected]")
-        .lud16("yuki@getalby.com");
+        .lud16("pay@yukikishimoto.com");
 
     await client.setMetadata(metadata);
 
@@ -57,4 +57,4 @@ async function main() {
     await client.sendEventBuilder(builder);
 }
 
-main();
+main();
diff --git a/bindings/nostr-sdk-js/examples/metadata.js b/bindings/nostr-sdk-js/examples/metadata.js
@@ -3,10 +3,10 @@ const { Metadata, loadWasmSync } = require("../");
 function main() {
     loadWasmSync();
 
-    let metadata = new Metadata().name("test").displayName("Testing Rust Nostr").lud16("yuki@getalby.com");
+    let metadata = new Metadata().name("test").displayName("Testing Rust Nostr").lud16("pay@yukikishimoto.com");
 
     console.log("JSON:", metadata.asJson());
     console.log("Display name:", metadata.getDisplayName());
 }
 
-main();
+main();
diff --git a/bindings/nostr-sdk-js/examples/nip05.js b/bindings/nostr-sdk-js/examples/nip05.js
@@ -4,11 +4,11 @@ async function main() {
     await loadWasmAsync();
 
     let public_key = PublicKey.fromBech32("npub1drvpzev3syqt0kjrls50050uzf25gehpz9vgdw08hvex7e0vgfeq0eseet");
-    if (await verifyNip05(public_key, "yuki@getalby.com")) {
+    if (await verifyNip05(public_key, "pay@yukikishimoto.com")) {
         console.log("Valid NIP05")
     } else {
         console.log("Invalid NIP05: " + error)
     }
 }
 
-main();
+main();
diff --git a/book/snippets/nostr/js/.gitignore → book/snippets/js/.gitignore b/book/snippets/nostr/js/.gitignore → book/snippets/js/.gitignore
diff --git a/book/snippets/nostr/js/index.js → book/snippets/js/index.js b/book/snippets/nostr/js/index.js → book/snippets/js/index.js
diff --git a/book/snippets/nostr/js/package.json → book/snippets/js/package.json b/book/snippets/nostr/js/package.json → book/snippets/js/package.json
diff --git a/book/snippets/nostr/js/src/event/builder.js → book/snippets/js/src/event/builder.js b/book/snippets/nostr/js/src/event/builder.js → book/snippets/js/src/event/builder.js
diff --git a/book/snippets/nostr/js/src/event/json.js → book/snippets/js/src/event/json.js b/book/snippets/nostr/js/src/event/json.js → book/snippets/js/src/event/json.js
diff --git a/book/snippets/nostr/js/src/keys.js → book/snippets/js/src/keys.js b/book/snippets/nostr/js/src/keys.js → book/snippets/js/src/keys.js
diff --git a/.../snippets/nostr/js/src/messages/client.js → book/snippets/js/src/messages/client.js b/.../snippets/nostr/js/src/messages/client.js → book/snippets/js/src/messages/client.js
diff --git a/...snippets/nostr/js/src/messages/filters.js → book/snippets/js/src/messages/filters.js b/...snippets/nostr/js/src/messages/filters.js → book/snippets/js/src/messages/filters.js
diff --git a/book/snippets/nostr/js/src/messages/relay.js → book/snippets/js/src/messages/relay.js b/book/snippets/nostr/js/src/messages/relay.js → book/snippets/js/src/messages/relay.js
diff --git a/book/snippets/nostr/js/src/nip01.js → book/snippets/js/src/nip01.js b/book/snippets/nostr/js/src/nip01.js → book/snippets/js/src/nip01.js
diff --git a/book/snippets/nostr/js/src/nip05.js → book/snippets/js/src/nip05.js b/book/snippets/nostr/js/src/nip05.js → book/snippets/js/src/nip05.js
diff --git a/book/snippets/nostr/js/src/nip06.js → book/snippets/js/src/nip06.js b/book/snippets/nostr/js/src/nip06.js → book/snippets/js/src/nip06.js
diff --git a/book/snippets/nostr/js/src/nip19.js → book/snippets/js/src/nip19.js b/book/snippets/nostr/js/src/nip19.js → book/snippets/js/src/nip19.js
diff --git a/book/snippets/nostr/js/src/nip21.js → book/snippets/js/src/nip21.js b/book/snippets/nostr/js/src/nip21.js → book/snippets/js/src/nip21.js
diff --git a/book/snippets/nostr/js/src/nip44.js → book/snippets/js/src/nip44.js b/book/snippets/nostr/js/src/nip44.js → book/snippets/js/src/nip44.js
diff --git a/book/snippets/nostr/js/src/nip59.js → book/snippets/js/src/nip59.js b/book/snippets/nostr/js/src/nip59.js → book/snippets/js/src/nip59.js
diff --git a/book/snippets/nostr/js/src/nip65.js → book/snippets/js/src/nip65.js b/book/snippets/nostr/js/src/nip65.js → book/snippets/js/src/nip65.js
diff --git a/book/snippets/justfile b/book/snippets/justfile
@@ -1,3 +1,15 @@
-test:
-	cd nostr && just test
-	cd nostr-sdk && just test
+test: rust python js kotlin
+
+rust:
+	cd rust && cargo build
+
+python:
+	cd python && just test
+
+js:
+	cd js && npm i
+	node js/index.js
+
+kotlin:
+    cd kotlin && just test
+
diff --git a/book/snippets/nostr/kotlin/.gitignore → book/snippets/kotlin/.gitignore b/book/snippets/nostr/kotlin/.gitignore → book/snippets/kotlin/.gitignore
diff --git a/book/snippets/nostr/kotlin/build.gradle.kts → book/snippets/kotlin/build.gradle.kts b/book/snippets/nostr/kotlin/build.gradle.kts → book/snippets/kotlin/build.gradle.kts
diff --git a/book/snippets/nostr/kotlin/gradle.properties → book/snippets/kotlin/gradle.properties b/book/snippets/nostr/kotlin/gradle.properties → book/snippets/kotlin/gradle.properties
diff --git a/...ts/nostr/kotlin/gradle/libs.versions.toml → ...snippets/kotlin/gradle/libs.versions.toml b/...ts/nostr/kotlin/gradle/libs.versions.toml → ...snippets/kotlin/gradle/libs.versions.toml
diff --git a/.../kotlin/gradle/wrapper/gradle-wrapper.jar → .../kotlin/gradle/wrapper/gradle-wrapper.jar b/.../kotlin/gradle/wrapper/gradle-wrapper.jar → .../kotlin/gradle/wrapper/gradle-wrapper.jar
diff --git a/.../gradle/wrapper/gradle-wrapper.properties → .../gradle/wrapper/gradle-wrapper.properties b/.../gradle/wrapper/gradle-wrapper.properties → .../gradle/wrapper/gradle-wrapper.properties
diff --git a/book/snippets/nostr/kotlin/gradlew → book/snippets/kotlin/gradlew b/book/snippets/nostr/kotlin/gradlew → book/snippets/kotlin/gradlew
diff --git a/book/snippets/nostr/kotlin/gradlew.bat → book/snippets/kotlin/gradlew.bat b/book/snippets/nostr/kotlin/gradlew.bat → book/snippets/kotlin/gradlew.bat
diff --git a/book/snippets/nostr/kotlin/justfile → book/snippets/kotlin/justfile b/book/snippets/nostr/kotlin/justfile → book/snippets/kotlin/justfile
diff --git a/...snippets/nostr/kotlin/settings.gradle.kts → book/snippets/kotlin/settings.gradle.kts b/...snippets/nostr/kotlin/settings.gradle.kts → book/snippets/kotlin/settings.gradle.kts
diff --git a/...pets/nostr/kotlin/shared/build.gradle.kts → book/snippets/kotlin/shared/build.gradle.kts b/...pets/nostr/kotlin/shared/build.gradle.kts → book/snippets/kotlin/shared/build.gradle.kts
diff --git a/.../main/kotlin/rust/nostr/snippets/Event.kt → .../main/kotlin/rust/nostr/snippets/Event.kt b/.../main/kotlin/rust/nostr/snippets/Event.kt → .../main/kotlin/rust/nostr/snippets/Event.kt
diff --git a/...c/main/kotlin/rust/nostr/snippets/Keys.kt → ...c/main/kotlin/rust/nostr/snippets/Keys.kt b/...c/main/kotlin/rust/nostr/snippets/Keys.kt → ...c/main/kotlin/rust/nostr/snippets/Keys.kt
diff --git a/book/snippets/nostr-sdk/justfile b/book/snippets/nostr-sdk/justfile
diff --git a/book/snippets/nostr-sdk/rust/src/main.rs b/book/snippets/nostr-sdk/rust/src/main.rs
diff --git a/book/snippets/nostr-sdk/rust/src/quickstart.rs b/book/snippets/nostr-sdk/rust/src/quickstart.rs
diff --git a/book/snippets/nostr/justfile b/book/snippets/nostr/justfile
diff --git a/book/snippets/nostr/rust/.gitignore b/book/snippets/nostr/rust/.gitignore
diff --git a/book/snippets/nostr/rust/Cargo.toml b/book/snippets/nostr/rust/Cargo.toml
diff --git a/book/snippets/nostr/python/.gitignore → book/snippets/python/.gitignore b/book/snippets/nostr/python/.gitignore → book/snippets/python/.gitignore
diff --git a/book/snippets/nostr/python/justfile → book/snippets/python/justfile b/book/snippets/nostr/python/justfile → book/snippets/python/justfile
@@ -5,4 +5,4 @@ requirements: venv
 	. ENV/bin/activate && pip install -r requirements.txt
 
 test: requirements
-	. ENV/bin/activate && python main.py
+	. ENV/bin/activate && python main.py
diff --git a/book/snippets/nostr/python/main.py → book/snippets/python/main.py b/book/snippets/nostr/python/main.py → book/snippets/python/main.py
diff --git a/book/snippets/nostr/python/requirements.txt → book/snippets/python/requirements.txt b/book/snippets/nostr/python/requirements.txt → book/snippets/python/requirements.txt
diff --git a/...nippets/nostr/python/src/event/builder.py → book/snippets/python/src/event/builder.py b/...nippets/nostr/python/src/event/builder.py → book/snippets/python/src/event/builder.py
diff --git a/...nippets/nostr/python/src/event/eventid.py → book/snippets/python/src/event/eventid.py b/...nippets/nostr/python/src/event/eventid.py → book/snippets/python/src/event/eventid.py
diff --git a/book/snippets/nostr/python/src/event/json.py → book/snippets/python/src/event/json.py b/book/snippets/nostr/python/src/event/json.py → book/snippets/python/src/event/json.py
diff --git a/book/snippets/nostr/python/src/event/kind.py → book/snippets/python/src/event/kind.py b/book/snippets/nostr/python/src/event/kind.py → book/snippets/python/src/event/kind.py
diff --git a/book/snippets/nostr/python/src/event/tags.py → book/snippets/python/src/event/tags.py b/book/snippets/nostr/python/src/event/tags.py → book/snippets/python/src/event/tags.py
diff --git a/book/snippets/nostr/python/src/keys.py → book/snippets/python/src/keys.py b/book/snippets/nostr/python/src/keys.py → book/snippets/python/src/keys.py
diff --git a/...ppets/nostr/python/src/messages/client.py → book/snippets/python/src/messages/client.py b/...ppets/nostr/python/src/messages/client.py → book/snippets/python/src/messages/client.py
diff --git a/...pets/nostr/python/src/messages/filters.py → book/snippets/python/src/messages/filters.py b/...pets/nostr/python/src/messages/filters.py → book/snippets/python/src/messages/filters.py
diff --git a/...ippets/nostr/python/src/messages/relay.py → book/snippets/python/src/messages/relay.py b/...ippets/nostr/python/src/messages/relay.py → book/snippets/python/src/messages/relay.py
diff --git a/book/snippets/nostr/python/src/nip01.py → book/snippets/python/src/nip01.py b/book/snippets/nostr/python/src/nip01.py → book/snippets/python/src/nip01.py
diff --git a/book/snippets/nostr/python/src/nip05.py → book/snippets/python/src/nip05.py b/book/snippets/nostr/python/src/nip05.py → book/snippets/python/src/nip05.py
diff --git a/book/snippets/nostr/python/src/nip06.py → book/snippets/python/src/nip06.py b/book/snippets/nostr/python/src/nip06.py → book/snippets/python/src/nip06.py
diff --git a/book/snippets/nostr/python/src/nip19.py → book/snippets/python/src/nip19.py b/book/snippets/nostr/python/src/nip19.py → book/snippets/python/src/nip19.py
diff --git a/book/snippets/nostr/python/src/nip21.py → book/snippets/python/src/nip21.py b/book/snippets/nostr/python/src/nip21.py → book/snippets/python/src/nip21.py
diff --git a/book/snippets/nostr/python/src/nip44.py → book/snippets/python/src/nip44.py b/book/snippets/nostr/python/src/nip44.py → book/snippets/python/src/nip44.py
diff --git a/book/snippets/nostr/python/src/nip59.py → book/snippets/python/src/nip59.py b/book/snippets/nostr/python/src/nip59.py → book/snippets/python/src/nip59.py
diff --git a/book/snippets/nostr/python/src/nip65.py → book/snippets/python/src/nip65.py b/book/snippets/nostr/python/src/nip65.py → book/snippets/python/src/nip65.py
diff --git a/book/snippets/nostr/python/src/timestamps.py → book/snippets/python/src/timestamps.py b/book/snippets/nostr/python/src/timestamps.py → book/snippets/python/src/timestamps.py
diff --git a/book/snippets/nostr-sdk/rust/.gitignore → book/snippets/rust/.gitignore b/book/snippets/nostr-sdk/rust/.gitignore → book/snippets/rust/.gitignore
diff --git a/book/snippets/nostr-sdk/rust/Cargo.toml → book/snippets/rust/Cargo.toml b/book/snippets/nostr-sdk/rust/Cargo.toml → book/snippets/rust/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "snippets-nostr-sdk-rust"
+name = "snippets-rust"
 version = "0.1.0"
 edition = "2021"
 

diff --git a/.../snippets/nostr/rust/src/event/builder.rs → book/snippets/rust/src/event/builder.rs b/.../snippets/nostr/rust/src/event/builder.rs → book/snippets/rust/src/event/builder.rs
@@ -1,4 +1,4 @@
-use nostr::prelude::*;
+use nostr_sdk::prelude::*;
 
 pub fn event() -> Result<()> {
     let keys = Keys::generate();

diff --git a/book/snippets/nostr/rust/src/event/json.rs → book/snippets/rust/src/event/json.rs b/book/snippets/nostr/rust/src/event/json.rs → book/snippets/rust/src/event/json.rs
@@ -1,4 +1,4 @@
-use nostr::prelude::*;
+use nostr_sdk::prelude::*;
 
 pub fn event() -> Result<()> {
     // Deserialize from json

diff --git a/book/snippets/nostr/rust/src/event/mod.rs → book/snippets/rust/src/event/mod.rs b/book/snippets/nostr/rust/src/event/mod.rs → book/snippets/rust/src/event/mod.rs
diff --git a/book/snippets/rust/src/hello.rs b/book/snippets/rust/src/hello.rs
@@ -0,0 +1,28 @@
+// ANCHOR: all
+use nostr_sdk::prelude::*;
+
+pub async fn hello() -> Result<()> {
+    // ANCHOR: keys
+    let keys: Keys = Keys::generate();
+    // ANCHOR_END: keys
+
+    // ANCHOR: client
+    let client = Client::new(keys);
+    // ANCHOR_END: client
+
+    // ANCHOR: connect
+    client.add_relay("wss://relay.damus.io").await?;
+    client.add_read_relay("wss://relay.nostr.info").await?;
+
+    client.connect().await;
+    // ANCHOR_END: connect
+
+    // ANCHOR: publish
+    let builder = EventBuilder::text_note("Hello, rust-nostr!", []);
+    client.send_event_builder(builder).await?;
+    // ANCHOR_END: publish
+
+    Ok(())
+}
+
+// ANCHOR_END: all
diff --git a/book/snippets/nostr/rust/src/keys.rs → book/snippets/rust/src/keys.rs b/book/snippets/nostr/rust/src/keys.rs → book/snippets/rust/src/keys.rs
@@ -1,4 +1,4 @@
-use nostr::prelude::*;
+use nostr_sdk::prelude::*;
 
 // ANCHOR: generate
 pub fn generate() -> Result<()> {

diff --git a/book/snippets/nostr/rust/src/main.rs → book/snippets/rust/src/main.rs b/book/snippets/nostr/rust/src/main.rs → book/snippets/rust/src/main.rs
@@ -7,5 +7,8 @@ mod messages;
 mod nip01;
 mod nip44;
 mod nip59;
+mod hello;
+mod nip17;
 
-fn main() {}
+#[tokio::main]
+async fn main() {}
diff --git a/book/snippets/nostr/rust/src/messages/mod.rs → book/snippets/rust/src/messages/mod.rs b/book/snippets/nostr/rust/src/messages/mod.rs → book/snippets/rust/src/messages/mod.rs
diff --git a/...snippets/nostr/rust/src/messages/relay.rs → book/snippets/rust/src/messages/relay.rs b/...snippets/nostr/rust/src/messages/relay.rs → book/snippets/rust/src/messages/relay.rs
@@ -1,4 +1,4 @@
-use nostr::prelude::*;
+use nostr_sdk::prelude::*;
 
 pub fn relay_message() -> Result<()> {
     // Deserialize from json

diff --git a/book/snippets/nostr/rust/src/nip01.rs → book/snippets/rust/src/nip01.rs b/book/snippets/nostr/rust/src/nip01.rs → book/snippets/rust/src/nip01.rs
@@ -1,4 +1,4 @@
-use nostr::prelude::*;
+use nostr_sdk::prelude::*;
 
 pub fn nip01() -> Result<()> {
     let keys = Keys::generate();

diff --git a/book/snippets/nostr-sdk/rust/src/nip17.rs → book/snippets/rust/src/nip17.rs b/book/snippets/nostr-sdk/rust/src/nip17.rs → book/snippets/rust/src/nip17.rs
diff --git a/book/snippets/nostr/rust/src/nip44.rs → book/snippets/rust/src/nip44.rs b/book/snippets/nostr/rust/src/nip44.rs → book/snippets/rust/src/nip44.rs
@@ -1,4 +1,4 @@
-use nostr::prelude::*;
+use nostr_sdk::prelude::*;
 
 pub fn run() -> Result<()> {
     let keys = Keys::generate();

diff --git a/book/snippets/nostr/rust/src/nip59.rs → book/snippets/rust/src/nip59.rs b/book/snippets/nostr/rust/src/nip59.rs → book/snippets/rust/src/nip59.rs
@@ -1,4 +1,4 @@
-use nostr::prelude::*;
+use nostr_sdk::prelude::*;
 
 pub async fn run() -> Result<()> {
     // Sender keys

diff --git a/...pets/nostr/swift/NostrSnippets/.gitignore → book/snippets/swift/NostrSnippets/.gitignore b/...pets/nostr/swift/NostrSnippets/.gitignore → book/snippets/swift/NostrSnippets/.gitignore
diff --git a/...s/nostr/swift/NostrSnippets/Package.swift → ...nippets/swift/NostrSnippets/Package.swift b/...s/nostr/swift/NostrSnippets/Package.swift → ...nippets/swift/NostrSnippets/Package.swift
diff --git a/...NostrSnippets/Sources/Event/Builder.swift → ...NostrSnippets/Sources/Event/Builder.swift b/...NostrSnippets/Sources/Event/Builder.swift → ...NostrSnippets/Sources/Event/Builder.swift
diff --git a/...ft/NostrSnippets/Sources/Event/Json.swift → ...ft/NostrSnippets/Sources/Event/Json.swift b/...ft/NostrSnippets/Sources/Event/Json.swift → ...ft/NostrSnippets/Sources/Event/Json.swift
diff --git a/...tr/swift/NostrSnippets/Sources/Keys.swift → ...ts/swift/NostrSnippets/Sources/Keys.swift b/...tr/swift/NostrSnippets/Sources/Keys.swift → ...ts/swift/NostrSnippets/Sources/Keys.swift
diff --git a/.../swift/NostrSnippets/Sources/Vanity.swift → .../swift/NostrSnippets/Sources/Vanity.swift b/.../swift/NostrSnippets/Sources/Vanity.swift → .../swift/NostrSnippets/Sources/Vanity.swift
diff --git a/...tr/swift/NostrSnippets/Sources/main.swift → ...ts/swift/NostrSnippets/Sources/main.swift b/...tr/swift/NostrSnippets/Sources/main.swift → ...ts/swift/NostrSnippets/Sources/main.swift
diff --git a/...r/swift/NostrSnippets/Sources/nip44.swift → ...s/swift/NostrSnippets/Sources/nip44.swift b/...r/swift/NostrSnippets/Sources/nip44.swift → ...s/swift/NostrSnippets/Sources/nip44.swift
diff --git a/...r/swift/NostrSnippets/Sources/nip59.swift → ...s/swift/NostrSnippets/Sources/nip59.swift b/...r/swift/NostrSnippets/Sources/nip59.swift → ...s/swift/NostrSnippets/Sources/nip59.swift
diff --git a/...ippets/nostr/swift/NostrSnippets/justfile → book/snippets/swift/NostrSnippets/justfile b/...ippets/nostr/swift/NostrSnippets/justfile → book/snippets/swift/NostrSnippets/justfile
diff --git a/book/src/README.md b/book/src/README.md
@@ -28,12 +28,6 @@
 
 * **Customizable**: The libraries are built in modular way, allowing to build customized nostr apps.
 
-## Libraries
-
-* [Nostr](./nostr/index.md): Implementation of the `nostr` protocol
-* [Nostr Database](): Databases abstraction, indexes and in-memory database implementation
-* [Nostr SDK](./nostr-sdk/index.md): High level nostr client library
-
 ## Communication
 
 * Nostr community: <nostr:naddr1qvzqqqyx7cpzq6xcz9jerqgqkldy8lpg7lglcyj4g3nwzy2cs6u70wejdaj7csnjqyg8wumn8ghj7mn0wd68ytnddakj7qgawaehxw309ahx7um5wghx6at5d9h8jampd3kx2apwvdhk6tcqpfe82um594hx7um5wguyvg2q>

diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -2,38 +2,58 @@
 
 [Introduction](README.md)
 
-# Libraries
-
-* [Nostr](nostr/index.md)
-    * [Installation](nostr/installation.md)
-    * [Signers](nostr/signers/index.md)
-        * [Keys](nostr/signers/keys.md)
-    * [Event](nostr/event/index.md)
-        * [Event ID](nostr/event/id.md)
-        * [Kind](nostr/event/kind.md)
-        * [Timestamp](nostr/event/timestamp.md)
-        * [Tag](nostr/event/tag.md)
-    * [Messages](nostr/messages/index.md)
-        * [Client Message](nostr/messages/client.md)
-            * [Filters](nostr/messages/filters.md)
-        * [Relay Message](nostr/messages/relay.md)
-    * [NIPs](nostr/nips/index.md)
-        * [NIP-01](nostr/nips/01.md)
-        * [NIP-05](nostr/nips/05.md)
-        * [NIP-06](nostr/nips/06.md)
-        * [NIP-07](nostr/nips/07.md)
-        * [NIP-19](nostr/nips/19.md)
-        * [NIP-21](nostr/nips/21.md)
-        * [NIP-44](nostr/nips/44.md)
-        * [NIP-59](nostr/nips/59.md)
-        * [NIP-65](nostr/nips/65.md)
-
-* [Nostr SDK](nostr-sdk/index.md)
-    * [Installation](nostr-sdk/installation.md)
-    * [Quickstart](nostr-sdk/quickstart.md)
-    * [Private Messages (NIP-17)](nostr-sdk/nip17.md)
-    * [Options](nostr-sdk/options/index.md)
-        * [Proxy](nostr-sdk/options/proxy.md)
+# SDK
+
+* [Getting Started](sdk/getting-started.md)
+    * [Installation](sdk/install.md)
+    * [Enabling logging](sdk/logging.md)
+    * [Hello, rust-nostr!](sdk/hello.md)
+
+* [Signers](sdk/signers/index.md)
+    * [Keys](sdk/signers/keys.md)
+    * [Browser Extension (NIP07)](sdk/nips/07.md)
+    * [Nostr Connect (NIP46)](sdk/signers/nostr-connect.md)
+
+* [Event](sdk/event/index.md)
+    * [ID](sdk/event/id.md)
+    * [Kind](sdk/event/kind.md)
+    * [Tag](sdk/event/tag.md)
+    * [Builder](sdk/event/builder.md)
+
+* [Filters](sdk/messages/filters.md)
+
+* [Client](sdk/client/index.md)
+    * [Options](sdk/client/options/index.md)
+        * [Proxy](sdk/client/options/proxy.md)
+        * [Embedded Tor](sdk/client/options/tor.md)
+
+* [NIPs](sdk/nips/index.md)
+    * [NIP-01: Basic protocol flow description](sdk/nips/01.md)
+    * [NIP-05: Mapping nostr keys to DNS-based internet identifiers](sdk/nips/05.md)
+    * [NIP-06: Key derivation from seed phrase](sdk/nips/06.md)
+    * [NIP-07: Browser Extension Signer](sdk/nips/07.md)
+    * [NIP-17: Private Direct Messages](sdk/nips/17.md)
+    * [NIP-19: bech32-encoded entities](sdk/nips/19.md)
+    * [NIP-21: nostr URI scheme](sdk/nips/21.md)
+    * [NIP-44: Encrypted Payloads](sdk/nips/44.md)
+    * [NIP-59: Gift Wrap](sdk/nips/59.md)
+    * [NIP-65: Relay List Metadata](sdk/nips/65.md)
+
+# Advanced
+
+* [Messages](sdk/messages/index.md)
+    * [Client Message](sdk/messages/client.md)
+    * [Relay Message](sdk/messages/relay.md)
+
+---
+
+# CLI
+
+* [Getting Started]()
+  * [Installation]()
+
+* [Shell]()
+---
 
 [Changelog](changelog.md)
 [Donate](donate.md)