quill: draft timmy journal README
This commit is contained in:
1 parent
4d0ab9df51
commit
c422324cb3
1 file changed
+33
@@ -0,0 +1,33 @@
|
||||
# Timmy Bowel-Health Journal
|
||||
|
||||
A CLI-first, self-hosted journal for tracking bowel movements with health metrics.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pip install timmy-journal
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
timmy log --time "08:30" --type "formed" --notes "felt normal"
|
||||
timmy stats --last 30d
|
||||
```
|
||||
|
||||
## Data Schema
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| ts | ISO8601 | Event timestamp |
|
||||
| type | enum | formed / loose / watery / constipated |
|
||||
| bristol | 1-7 | Bristol stool scale |
|
||||
| notes | text | Freeform notes |
|
||||
|
||||
## Privacy
|
||||
|
||||
All data stays local; encrypted at rest.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in new issue
Block a user