@@ 26,22 26,45 @@ Build:
+Make sure the $EDITOR environment variable is set. To save it between sessions
+add it to your `.bashrc`.
-Then follow along with the prompt.
+This will present a prompt with instructions to follow along with.
+There are currently 3 types of actions:
+1. new -
+ Create a new hub or zettel. If zettel, opens with $EDITOR.
+2. query -
+ Query for a zettel and open it with $EDITOR.
+3. link -
+ Query for 2 different zettels and append a LINK tag to both files.
+ This creates a bidirectional link between both zettels.
-Generally provides three modes: new, query, and link.
+Hubs are simply folders for zettels to be contained in. Their purpose is to form
+a shallow organization system for the zettels. This makes it easier to search.
+Hubs functionally replace the idea of tags.
-new can create a new hub or zettel. Hubs are simply folders for categorization.
-query can navigate to a zettel.
+A zettel is a short note saved as a markdown file with an 8 digit UUID filename.
+The 4 digit ID for the zettel is derived from the filename.
-link can add link tags to two zettels, behaves similarly to query.
+A newly created zettel will look something like this:
-zettels are the markdown files in these folders (hubs);
-Make sure $EDITOR is set with your preferred editor.
-The editor is opened upon selecting a zettel during a query, or
-when creating a new zettel.