From a5464e19c9b43e463f0d809103cf690aee2043b5 Mon Sep 17 00:00:00 2001 From: brian Date: Tue, 9 Mar 2021 01:00:29 -0500 Subject: [PATCH] high-level overview of app --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b62fa2a..dab4064 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # pastebin -Simple pastebin made with Mithril JS. \ No newline at end of file +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. \ No newline at end of file