meowlog/README.md

50 lines
1.3 KiB
Markdown
Raw Normal View History

2024-10-14 18:52:37 +02:00
![img.png](assets/img.png)
2024-10-10 22:01:31 +02:00
# meowlog
---
2024-10-14 18:52:37 +02:00
## WIP SUBJECT TO CHANGE
### ⚠️ IMPORTANT
The client's core functionality (managing substances and ingestions) works. The codebase is a mess and will be heavily
2024-10-14 18:55:08 +02:00
refactored so use at your own risk. There will be no backwards compatibility until the first stable release.
2024-10-14 18:52:37 +02:00
Planned features:
- [x] Managing ingestions and substances
2024-10-14 18:55:08 +02:00
- [ ] Having a sensible set of default substances (taken from TripSit or PsychonautWiki idk yet)
2024-10-14 18:52:37 +02:00
- [ ] Circular Concurrency Checking for binary files
2024-10-14 18:55:08 +02:00
- [ ] Server with syncing capabilities and maybe also a frontend with a similar feature set like the Psychonaut Wiki
2024-10-14 18:52:37 +02:00
Journal app
- [ ] Referring to harm reduction resources in the CLI
Current problems:
- [ ] Codebase is a mess
- [ ] No tests
- [ ] Poor error handling
- [ ] Unoptimized memory usage
2024-10-10 22:01:31 +02:00
---
2024-10-14 18:52:37 +02:00
### Client usage:
2024-10-10 22:01:31 +02:00
```
Commands:
add-ingestion Adds ingestion
edit-ingestion Edits an ingestion
list-ingestions List ingestions
remove-ingestion Remove ingestion
add-substance Adds substance
edit-substance Edits an substance
list-substances List substances
remove-substance Remove substance
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
```