diff --git a/README.md b/README.md index 8c59057..ada1927 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,10 @@ godo tui For more information, use the `godo help` command. +## Show me the render! + +![video example of use](demo.svg) + ## Customization Default colors can be overwritten in the configuration file (`~/.config/godo/config.json`). diff --git a/demo.svg b/demo.svg new file mode 100644 index 0000000..8b95572 --- /dev/null +++ b/demo.svg @@ -0,0 +1 @@ +$$g$go$god$godo$godoversion####Godo####Version:v1.1.0Buildtime:2023-11-0115:19:13Commithash:40487eec14dc4539367ac4c9990af510bb502252$godoinit$godohelpSimpleTodolistApplicationtosaveandmanageto-dosbysavingthemtoyourlocalstorage.Usage:godo[command]AvailableCommands:addAddanewTask.addListCreateanewList.checkMarkaTaskasdone.cleanAppCleantheApplication.clearListRemovesTasksfromaList.completionGeneratetheautocompletionscriptforthespecifiedshellhelpHelpaboutanycommandinitInittheApplication.lsPrintsTasks.lsListPrintsexistingLists.rmRemovesaTask.rmListRemovesanemptyList.tuiupdateUpdatesaTask.updateListUpdatesaList.versionPrintsoutversion,commithashandbuildtimeofthebinary.Flags:-h,--helphelpforgodoUse"godo[command]--help"formoreinformationaboutacommand.$godoa$godoad$godoadd$godoaddList$godoaddList--list$godoaddList--list-name$godoaddList--list-namegroceriesThenewlist'groceries'hasbeenadded.$godol$godols$godolsList┌────────────────┐Lists├────┬───────────┤IDName1groceries└────┴───────────┘$godoadd-$godoadd--$godoadd--helpAddanewTaskinaList.godoadd[flags]Aliases:add,a-d,--due-datestringDuedatefortheTask(format:2006-01-0215:04)-h,--helphelpforadd-l,--list-iduintIdoftheListwheretoaddyourTask.-n,--namestringNameoftheTask.-p,--prioritystringPriorityofyourTask[HIGH,MEDIUM,LOW].(default"LOW")$godo-$godo--$godo--l$godo--li$godo--lis$godo--list$godoadd--list-id$godoadd--list-id1$godoadd--list-id1--name$godoadd--list-id1--nameapplesNewTaskadded.Id:1Name:'apples'Duedate:0001-01-0100:00:00+0000UTCDone:falsePriority:LOW┌─────────────────────────────────────────────────────────┐ID:1-Name:groceries├────┬────────┬──────────┬──────────┬──────┬──────────────┤IDNameDueDatePriorityDoneCreated1applesNoneLOW0minuteago└────┴────────┴──────────┴──────────┴──────┴──────────────┘$godot$godotu$godotui╭──────────────────────╮groceries1itemapplesNone||LOW╰──────────────────────╯STATUS?TogglehelpqQuit>>2006-01-0215:04>low(default)?Togglehelpctrl+qQuitescCancelenterNext/Submit>w>wo>>tomato>2006-01-0215:04>low(default)2itemstomatoNone||LOWSTATUSTask 'tomato' created?Togglehelpctrl+qQuitescCancelenterSubmitnewListgrocerieswork2itemsNoitemsapplesNoitemsfound.STATUSList: 'work' added↑/kMoveupaCreateaListnCreateaTask↓/jMovedownrRenameaListuUpdateaTask←/hMoveleftDDeleteanemptyListenterToggleaTask→/lMoverightdDeleteaTask╭──────────────────────╮grocerieswork2itemsNoitemsapplesNoitemsfound.None||LOWtomatoNone||LOW╰──────────────────────╯>improvedocumentation>HIGH2items1itemapplesimproveNone||LOWdocumentati…None||HIGHSTATUSTask 'improve documentation' createdNothingtodo.$godotui-$godotui--$godotui--helpgodotui[flags]-h,--helphelpfortui-l,--list-per-pageintNumberofliststodisplayperpage.(default3)$godotui--list-per$godotui--list-per-page$godotui--list-per-page1╭────────────────────────────────────────────────────────────────────────╮groceries2itemsapplesNone||LOWtomatoNone||LOW╰────────────────────────────────────────────────────────────────────────╯work1itemimprovedocumentationNone||HIGHNone||LOWapplestomatoNone|🗹|LOWSTATUSTask 'tomato' toggledNone|🗹|LOWSTATUSTask 'apples' toggledNoitemsNoitemsfound.STATUS$godov$godove$godover$godovers$godoversi$godoversio$godoi$godoin$godoini$godoh$godohe$godohel$godoaddL$godoaddLi$godoaddLis$godoaddList-$godoaddList--$godoaddList--l$godoaddList--li$godoaddList--lis$godoaddList--listn$godoaddList--list-$godoaddList--list-n$godoaddList--list-na$godoaddList--list-nam$godoaddList--list-nameg$godoaddList--list-namegr$godoaddList--list-namegro$godoaddList--list-namegroc$godoaddList--list-namegroce$godoaddList--list-namegrocer$godoaddList--list-namegroceri$godoaddList--list-namegrocerie$godolsL$godolsLi$godolsLis$godoadd--h$godoadd--he$godoadd--hel$godo--list-$godoadd--l$godoadd--li$godoadd--lis$godoadd--list$godoadd--list-$godoadd--list-i$godoadd--list-id1-$godoadd--list-id1--$godoadd--list-id1--n$godoadd--list-id1--na$godoadd--list-id1--nam$godoadd--list-id1--namea$godoadd--list-id1--nameap$godoadd--list-id1--nameapp$godoadd--list-id1--nameappl$godoadd--list-id1--nameapple?Togglehelp>wo>t>to>tom>toma>toma>tomat>tomatoSTATUSTask 'tomat?Togglehelpctrl+qQuitescCancelenterSub>wor>work>workSTATUSTask 'tomato' created←/h2itemsNoitems?>i>im>imp>impr>impro>improv>improve>improve>improved>improvedo>improvedoc>improvedocu>improvedocum>improvedocume>improvedocumen>improvedocument>improvedocumenta>improvedocumentat>improvedocumentati>improvedocumentatio>improvedocumentation>H>HI>HIG>HIGHSTATUS→/l2items1item$godotui--h$godotui--he$godotui--hel$^[[A$^[[$^[$godotui--l$godotui--li$godotui--lis$godotui--list$godotui--list-$godotui--list-p$godotui--list-pe$godotui--list-perp$godotui--list-per-$godotui--list-per-p$godotui--list-per-pa$godotui--list-per-pagapplesNone||HIGHSTATUSTask 'apples' removedSTATUSTask 'tomato' removedSTATUSList 'groceries' deleted \ No newline at end of file