high-level overview of app

2021-03-09 01:00:29 -05:00
parent 60f3032e8b
commit a5464e19c9
1 changed files with 27 additions and 1 deletions
@@ -1,3 +1,29 @@
 # pastebin

 Simple pastebin made with Mithril JS.
+
+## User Interface (UI)
+
+Along the top are:
+
+- "New Note..." button
+- Search box
+- "Sort" dropdown
+
+On the top-right are:
+
+- Bin ID
+- "New Bin..." button
+
+The main area is simply a flexbox list of Notes.
+
+Each note contains:
+
+- Note text
+- "Edit" button
+
+## User Experience (UX)
+
+The root page creates a new bin, and sets the browser's `location` accordingly.
+
+Clicking "New Note..." clears the search and sort, so the new note comes out first in the list.