Skip to content

Commit

Permalink
Update readme with features and next steps
Browse files Browse the repository at this point in the history
  • Loading branch information
ajithnn committed Apr 27, 2022
1 parent b4ee225 commit 4e179eb
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,31 @@
# ullekha


A TUI for a notes app. Add notes , todos , random text anything directly on the terminal. Provide a filepath to be able to persist notes across terminal sessions.
The app provides a completely mouse-free , keyboard-only interface to add / edit / delete / highlight notes. The viewport is scrollable and can adjust automatically to resizing.


** Built using Haskell & Brick Library : https://hackage.haskell.org/package/brick-0.62 **


## Features

- Add any number of notes
- Navigate the notes and delete selected notes
- Edit any note
- Mark a note as important and it will be highlighted
- Clone a note and then edit as required
- Auto adjust layout upon resizing
- Persistence through a text file.
- Paste into the note


## To Be added

[ ] Add note groups
[ ] Allow persistence across devices
[ ] Allow user to override keyboard shortcuts
[ ] Multi-select and delete
[ ] Allow Checkboxes within the note
[ ] Timed notes which expire

0 comments on commit 4e179eb

Please sign in to comment.