Deploy book

rust-nostr · Sep 30, 2023 · 20f99e7 · 20f99e7
1 parent 5b1dc6c
commit 20f99e7
Show file tree

Hide file tree

Showing 12 changed files with 1,188 additions and 65 deletions.
diff --git a/book/404.html b/book/404.html
@@ -373,6 +373,8 @@
 
 
 
+
+
 
 
     <li class="md-nav__item md-nav__item--nested">
@@ -461,6 +463,26 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/book/nostr/04-keys/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Keys
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 

diff --git a/book/index.html b/book/index.html
@@ -386,6 +386,8 @@
 
 
 
+
+
 
 
     <li class="md-nav__item md-nav__item--nested">
@@ -474,6 +476,26 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="nostr/04-keys/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Keys
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -610,6 +632,42 @@
 
 
 
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+        <li class="md-nav__item">
+  <a href="#libraries" class="md-nav__link">
+    Libraries
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#state" class="md-nav__link">
+    State
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#license" class="md-nav__link">
+    License
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#donations" class="md-nav__link">
+    Donations
+  </a>
+
+</li>
+
+    </ul>
+
 </nav>
                   </div>
                 </div>
@@ -627,7 +685,19 @@
 
 
 <h1 id="introduction">Introduction</h1>
-<p>TODO: introduction</p>
+<p>Collection of libraries to build fast and secure <code>nostr</code> application on <code>desktop</code>, <code>mobile</code> and <code>web</code> environments.</p>
+<h2 id="libraries">Libraries</h2>
+<ul>
+<li><a href="nostr/01-index/">Nostr</a>: Implementation of the <code>nostr</code> protocol</li>
+<li><a href="nostr-sdk/01-index/">Nostr SDK</a>: High level nostr client library</li>
+</ul>
+<h2 id="state">State</h2>
+<p><strong>These libraries are in ALPHA state</strong>, things that are implemented generally work but the API will change in breaking ways.</p>
+<h2 id="license">License</h2>
+<p>This project is distributed under the MIT software license.</p>
+<h2 id="donations">Donations</h2>
+<p>⚡ Tips: <a href="https://getalby.com/p/yuki">https://getalby.com/p/yuki</a></p>
+<p>⚡ Lightning Address: [email protected]</p>
 
 
 

diff --git a/book/nostr-sdk/01-index/index.html b/book/nostr-sdk/01-index/index.html
@@ -11,7 +11,7 @@
         <link rel="canonical" href="https://rust-nostr.github.io/book/nostr-sdk/01-index/">
 
 
-        <link rel="prev" href="../../nostr/03-features/">
+        <link rel="prev" href="../../nostr/04-keys/">
 
 
         <link rel="next" href="../02-installation/">
@@ -386,6 +386,8 @@
 
 
 
+
+
 
 
     <li class="md-nav__item md-nav__item--nested">
@@ -474,6 +476,26 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../nostr/04-keys/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Keys
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -639,7 +661,11 @@
 
 
 <h1 id="nostr-sdk">Nostr SDK</h1>
-<p>This section include documentation for the <code>nostr-sdk</code> library (all supported languages).</p>
+<p>This section include documentation for the <code>nostr-sdk</code> library for all the supported languages (Rust, Python, Swift and Kotlin).</p>
+<p>This library depends on <code>nostr</code> library so, before continue, take a look to the <a href="../../nostr/01-index/"><code>nostr</code></a> docs.</p>
+<p>If you're writing a typical Nostr client or bot, this is likely the library you need.</p>
+<p>However, the library is designed in a modular way and depends on several
+other lower-level crates. If you're attempting something more custom, you might be interested in <a href="../../nostr/01-index/"><code>nostr</code></a> library.</p>
 
 
 

diff --git a/book/nostr-sdk/02-installation/index.html b/book/nostr-sdk/02-installation/index.html
@@ -386,6 +386,8 @@
 
 
 
+
+
 
 
     <li class="md-nav__item md-nav__item--nested">
@@ -474,6 +476,26 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../nostr/04-keys/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Keys
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -557,8 +579,6 @@
       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
 
 
-
-
 
         <label class="md-nav__link md-nav__link--active" for="__toc">
 
@@ -587,8 +607,6 @@
 
 
 
-
-
 
     <label class="md-nav__title" for="__toc">
       <span class="md-nav__icon md-icon"></span>
@@ -597,7 +615,7 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#installing-the-library_1" class="md-nav__link">
+  <a href="#installing-the-library" class="md-nav__link">
     Installing the library
   </a>
 
@@ -690,8 +708,6 @@
 
 
 
-
-
 
     <label class="md-nav__title" for="__toc">
       <span class="md-nav__icon md-icon"></span>
@@ -700,7 +716,7 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#installing-the-library_1" class="md-nav__link">
+  <a href="#installing-the-library" class="md-nav__link">
     Installing the library
   </a>
 
@@ -758,8 +774,9 @@
 
 
 
-<h1 id="installing-the-library">Installing the library</h1>
-<h2 id="installing-the-library_1">Installing the library</h2>
+  <h1>Installation</h1>
+
+<h2 id="installing-the-library">Installing the library</h2>
 <div class="tabbed-set tabbed-alternate" data-tabs="1:4"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><input id="__tabbed_1_4" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Rust</label><label for="__tabbed_1_2">Python</label><label for="__tabbed_1_3">Kotlin</label><label for="__tabbed_1_4">Swift</label></div>
 <div class="tabbed-content">
 <div class="tabbed-block">

diff --git a/book/nostr-sdk/03-features/index.html b/book/nostr-sdk/03-features/index.html
@@ -384,6 +384,8 @@
 
 
 
+
+
 
 
     <li class="md-nav__item md-nav__item--nested">
@@ -472,6 +474,26 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../nostr/04-keys/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Keys
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 

diff --git a/book/nostr/01-index/index.html b/book/nostr/01-index/index.html
@@ -387,6 +387,8 @@
 
 
 
+
+
 
 
 
@@ -486,6 +488,26 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../04-keys/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Keys
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -639,7 +661,8 @@
 
 
 <h1 id="nostr">Nostr</h1>
-<p>This section include documentation for the <code>nostr</code> library (all supported languages).</p>
+<p>This section include documentation for the <code>nostr</code> library for all the supported languages (Rust, Python, Swift and Kotlin).</p>
+<p>If you're writing a typical Nostr client or bot, you may be interested in <a href="../../nostr-sdk/01-index/">nostr-sdk</a>.</p>