From 7aa3760711f688a69bc5b5365bdf642f3b89cad8 Mon Sep 17 00:00:00 2001 From: agatha Date: Sun, 12 May 2024 15:13:21 -0400 Subject: [PATCH] update README.md --- README.md | 31 +++++++------------------------ 1 file changed, 7 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 2745bce..11cc6ce 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,15 @@ # ketotrack -Simple GKI calculator written as an exercise in learning Go. +Simple ketosis tracker written in Go. -Currently, this only calculates your GKI and stores the results into a JSON file. At some point I'll get around to -implementing note-taking and time-series display. +## Features +- Record your blood glucose and ketone levels +- Record notes about things that might affect your ketosis -## Usage -After measuring your blood glucose and blood ketone levels, run `ketotrack`. GKI will be displayed along with -the level of ketosis you are in according to [Keto-Mojo](https://keto-mojo.com/glucose-ketone-index-gki/): -``` -Enter glucose reading (mg/dL): 77 -Enter ketone reading (mmol/L): 1.1 - -Your GKI is: 3.89 -You're in a moderate level of ketosis. -``` - -Reading data will be saved to `$HOME/.ketotrack/readings.json`. +Reading data will be saved to `$HOME/.ketotrack/records.json` and graphing will be implemented at a later date. ## Building and Installing +At some point I'll include a Makefile, until then manually build and copy to any directory in your path. ```shell go build mv ketotrack $HOME/.local/bin -``` - -## Refactoring Notes -- [X] Create `Record` and `Note` struct types -- [X] Add `GKI` field to `Reading` struct type -- [X] Encapsulate application data with an `AppContext` struct that holds a `Records` slice - - [X] `LoadRecords`, `SaveRecords`, `AddReading`, `AddNote` receiver methods -- [X] Add interactive menu for adding either a `Note` or a `Record` -- [ ] Standardize method names for getting user input to `handleNewNote` and `handleNewReading` \ No newline at end of file +``` \ No newline at end of file