diff --git a/CHANGELOG.md b/CHANGELOG.md index d9bbc3d..7e3636a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +Nothing yet! + +## [0.3.0] + ### Added * feature: add a CLI command to generate sample data, very useful for UX testing diff --git a/Cargo.lock b/Cargo.lock index acc3d69..c605408 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1962,7 +1962,7 @@ dependencies = [ [[package]] name = "suffice" -version = "0.3.0-a" +version = "0.3.0" dependencies = [ "async-stream", "average", diff --git a/Cargo.toml b/Cargo.toml index 2e00ed5..da8107e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "suffice" -version = "0.3.0-a" +version = "0.3.0" description = "Suffice is a terminal-based tool for controlling a cycling trainer, so you can pound pedals while peddling code." keywords = ["bluetooth", "tui", "cycling"] categories = ["command-line-utilities"] diff --git a/README.md b/README.md index 41a9c39..4403f25 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,21 @@ ## Goals -* modes: ERG, Level, maybe Sim if I'm feeling spicy -* run as a daemon, see status of the trainer in starship +* modes: ERG, Level, Workout +* uber-minimal aesthetics + * simple TUI + * run as a daemon with starship.rs integration * record FIT (or similar) files to prove your sweat ## Non Goals * non-cycling machines +* Simulation mode ## Usage +`cargo install suffice` + ### CLI Options ``` @@ -41,6 +46,10 @@ Options: * `` - switch between power modes: ERG, Resist * `` - adjust the difficulty of the power mode +## Development + +[just](https://github.com/casey/just) is used for the main development tasks, with the build environment specified via `docker`. + ## Resources Used * the official [FTMS spec](https://www.bluetooth.org/DocMan/handlers/DownloadDoc.ashx?doc_id=423422)