diff options
author | Akshay <nerdy@peppe.rs> | 2020-07-19 21:46:03 +0530 |
---|---|---|
committer | Akshay <nerdy@peppe.rs> | 2020-07-19 21:46:03 +0530 |
commit | 2d0160a9f242701c6edf5ffe607cbd801c8444e3 (patch) | |
tree | 9f85fe2c80f393b4adc7d3323fc3cea88d0fe380 | |
parent | 6a327372f2f7916129b309d5b851a1a6754d90f6 (diff) |
more docs0.1.2
-rw-r--r-- | readme.md | 60 |
1 files changed, 48 insertions, 12 deletions
@@ -1,18 +1,54 @@ -### dijo +<p align="center"> + <img height="200" src="https://u.peppe.rs/lz.png"> +</p> -> a tui digital event tracker/journal, soon +### About -![sample](https://u.peppe.rs/rc.png) +`dijo` is a habit tracker. It is curses-based, it runs in +your terminal. `dijo` is scriptable, hook it up [with +external +programs](https://github.com/NerdyPepper/dijo/wiki/Auto-Habits) +to track events without moving a finger. `dijo` is modal, +much like a certain text editor. -### features +### Features - - vim like motions - - vim like modal interactions - - human readable data format (json for now) + - **vim like motions**: navigate `dijo` with `hjkl`! + - **`dijo` is modal**: different modes to view different + stats! + - **vim like command mode**: add with `:add`, delete with + `:delete` and above all, quit with `:q`!. + - **fully scriptable**: [configure `dijo` to + track your `git` commits](./Auto-Habits)! -### todo +### Install - - add 'cycle' habit - - add week stats mode - - add cli for scriptable habits - - everything on [notes.txt](./notes.txt) +Get `dijo` by running the following at the nearest prompt: + +``` +$ cargo install dijo +``` + +If you aren't familiar with `cargo` or Rust, read the [complete +installation](https://github.com/NerdyPepper/dijo/wiki/Install) +guide. + +### Usage + +`dijo` has a [detailed +wiki](https://github.com/NerdyPepper/dijo/wiki/), here are +some good places to start out: + + - [Getting started](https://github.com/NerdyPepper/dijo/wiki/Getting-Started) + - [Automatically tracking habits](https://github.com/NerdyPepper/dijo/wiki/Auto-Habits) + - [Command reference](https://github.com/NerdyPepper/dijo/wiki/Commands) + +### Gallery + +Day mode, shows days of the current month: + +![day.png](https://u.peppe.rs/qI.png) + +Week mode, shows weekly summary for the weeks of the month: + +![weekly.png](https://u.peppe.rs/HZ.png) |