repos / pico

commit

dc5a309

parent

0331923

author

Eric Bower

date

2024-10-07 03:23:13 +0000 UTC

docs(pubsub): copy

 1@@ -17,7 +17,7 @@
 2 {{define "body"}}
 3 <header class="flex flex-col items-center gap">
 4   <img src="https://pico.sh/logo.svg" alt="pico logo" width="50" height="50" />
 5-  <h1 class="text-2xl font-bold text-center">Authenticated <code>*nix</code> pipes over <code>ssh</code></h1>
 6+  <h1 class="text-2xl font-bold text-center">Authenticated *nix pipes over ssh</h1>
 7 </header>
 8 
 9 <hr />
10@@ -26,13 +26,33 @@
11   <div>
12     <p>
13       The simplest authenticated pubsub system.  Send messages through
14-      user-defined channels.  By default, channels are private to the authenticated
15+      user-defined topics.  By default, topics are private to the authenticated
16       ssh user.  The default pubsub model is multicast with bidirectional
17       blocking, meaning a publisher (<code>pub</code>) will send its message to all
18-      subscribers (<code>sub</code>) on a channel.  Further, both <code>pub</code> and
19-      <code>sub</code> will wait for at least one event to be sent or received on the channel.
20+      subscribers (<code>sub</code>) on a topic.  Further, both <code>pub</code> and
21+      <code>sub</code> will wait for at least one event to be sent or received on the topic.
22     </p>
23 
24+    <h2 class="text-lg">Features</h2>
25+
26+    <ol>
27+      <li>Familiar *nix pipes API</li>
28+      <li>Zero-install</li>
29+      <li>Authenticated pubsub using ssh</li>
30+      <li>Private pubsub by default</li>
31+      <li>Public pubsub by topic (opt-in)</li>
32+      <li>Multicast (many pubs to many subs)</li>
33+      <li>Bidirectional (e.g. chat)</li>
34+      <li>Configurable blocking for both pubs and subs</li>
35+      <li>Paradigms for connecting to a topic:
36+        <ol>
37+          <li>Read (sub)</li>
38+          <li>Write (pub)</li>
39+          <li>Read & Write (pipe)</li>
40+        </ol>
41+      </li>
42+    </ol>
43+
44     <blockquote>This service is undergoing active development, expect bugs, feature dev, and server restarts</blockquote>
45   </div>
46 
47@@ -211,6 +231,14 @@
48     </p>
49   </div>
50 
51+  <div>
52+    <h2 class="text-xl">Latest posts</h2>
53+    <div class="flex items-center">
54+      <div class="mr font-italic">2024-10-06</div>
55+      <div><a href="https://blog.pico.sh/pubsub">announcing pubsub service</a></div>
56+    </div>
57+  </div>
58+
59   <div class="text-center mb-2">
60     <p>built on our <a href="https://github.com/picosh/pubsub">go pkg</a>.</p>
61     <a href="https://pico.sh/getting-started" class="btn-link inline-block">GET STARTED</a>