-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme with features and next steps
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|