feat: update docs

kevmo314 · Nov 27, 2023 · 4c34ba6 · 4c34ba6
1 parent 8daa5ea
commit 4c34ba6
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,10 @@ Appendable currently supports data files in the following formats:
 
 with more formats coming soon.
 
+> [!CAUTION]
+> This README is currently somewhat aspirational and many features are not implemented yet.
+> Check out the <a href="https://kevmo314.github.io/appendable/">technical demo</a> for the functionality.
+
 ## Motivation
 
 A smart friend of mine once said
@@ -31,7 +35,7 @@ Appendable's primary goals are
 
 ## Demonstration
 
-Check out this repository's GitHub pages for an example querying the server.
+Check out this repository's <a href="https://kevmo314.github.io/appendable/">GitHub pages</a> for an example querying the server.
 
 ```ts
 import Appendable from "appendable";

diff --git a/examples/client/index.html b/examples/client/index.html
@@ -69,7 +69,10 @@
     </script>
   </head>
   <body>
-    <h1>Appendable - NYC Green Cab Trip Data in 01/2023</h1>
+    <h1>
+      <a href="https://github.com/kevmo314/appendable">Appendable</a> - NYC
+      Green Cab Trip Data in 01/2023
+    </h1>
     <div>
       Download the raw data here:
       <a href="green_tripdata_2023-01.jsonl">JSONL</a> -
@@ -78,6 +81,16 @@ <h1>Appendable - NYC Green Cab Trip Data in 01/2023</h1>
         >Source</a
       >
     </div>
+    <p>
+      Appendable is querying the JSONL and index files that GitHub pages hosts
+      <em>directly</em>. There is no server involved here!
+    </p>
+    <p>
+      Keep in mind that while the query syntax supports a lot of different
+      operations, Appendable doesn't support composite indexes yet. Therefore,
+      only one field at a time can be filtered on and that field must be used
+      for sorting.
+    </p>
     <div style="display: flex">
       <div>
         <h2>Fields</h2>