From ad5e3a26b67e960d1fa7a6f025cfe6c028b99eef Mon Sep 17 00:00:00 2001 From: Anish Lakhwara Date: Fri, 16 Jun 2023 20:07:28 +1000 Subject: [PATCH] update: readme --- README.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7e2c341..59cc2e5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,26 @@ A Tiny TUI that is compatible with [Loop Habits](). +### State of the Project +Until [this](https://github.com/iSoron/uhabits/issues/702) issue gets resolved, I have low desire to work on this further. In it's current state, it doesn't save changes, but it is able to import CSV exports from uHabits. + +If I'm still on android and the issue gets resolved, I'd integrate with their db and server as necessary. +If I move to a linux phone I'll write my own server implementation to keep my habits in sync across my devices. + +### Run +# Nix +I'm sorry Nix fam, I haven't packaged this yet, it's in the TODOs. +``` +nix develop +npm install +./node_modules/.bin/nbb src/habits/index.cljs +``` + +# Without Nix +You need to install `nbb`, which gets installed via `nodejs`, so you'll need that too. There are also some Babashka dependencies so you'll need to have `bb` available on your path too. + ### TODO +- Save changes to file - Parse date - Add all entries to current date - Read atoms from config @@ -20,9 +39,8 @@ A Tiny TUI that is compatible with [Loop Habits](). - Package with Nix so that it can run anywhere ### Built With -- [nbb]() -- [nodejs]() -- [ink]() -- [reagent]() -- [parse-csv]() -- [nix]() +- [nbb](https://github.com/babashka/nbb) +- [ink](https://github.com/vadimdemedes/ink#useinputinputhandler-options) +- [reagent](https://github.com/reagent-project/reagent) +- [parse-csv](https://github.com/adaltas/node-csv/tree/master/packages/csv-parse/) +- [nix](https://nixos.org/)