crunk-update/README.md
2023-11-05 22:05:09 +01:00

30 lines
1.4 KiB
Markdown

# crunk-update
a CLI tool to post updates to crunk-scheduler.
## Designing CLI tools
* I actually never did this properly. currently reading [this guide](https://clig.dev/)
* [and this one](https://betterprogramming.pub/building-cli-apps-in-rust-what-you-should-consider-99cdcc67710c)
## Make working software first
* `crunk-update --text "text"` should make a paragraph of `<p>text</p>` in [crunk-scheduler](https://git.vvvvvvaria.org/crunk/crunk-scheduler)
* `crunk-update --file "test.md"` should post a markdown file to [crunk-scheduler](https://git.vvvvvvaria.org/crunk/crunk-scheduler) and have it converted to html
* this is now possible and working. up next we should make some CLI flags such as --help (done through using clap)
## Learning Rust.
* [clap is a Command Line Argument Parser for Rust](https://docs.rs/clap/latest/clap/)
* [reqwest is a convenient, higher-level HTTP Client](https://docs.rs/reqwest/latest/reqwest/)
* [Tokio is an asynchronous runtime for the Rust programming language.](https://tokio.rs/)
## Readme driven development
* have crunk-scheduler do all the conversion to html in rss. ✅
* make this as simple as possible
- post a simple text ✅
- post markdown ✅
- post media files (jpeg, mp3, mp4 etc)
* be able to set a time when something is scheduled.
* and look up how to schedule a post
* have the url in a config file
* have the api-key in a config file (yes, everyone loves tokens, but this project is small)