diff --git a/readme.md b/readme.md index c43cb80..a63d2e1 100644 --- a/readme.md +++ b/readme.md @@ -54,6 +54,15 @@ You can now add it as a cron job, and make a daily request. ### Beta This is still beta. I use it and fixes the bugs when i find them. +### Version supported +The only version supported right now is semver, with or without a `v` prefix. Fx: + +1. `1.2.3` or +2. `v1.2.3` + +Not all github projects is doing tagging like this, so there is some projects that can't be watched right now. + + ### How to build There is no releases yet, but clone the repo, cd to the root and run `cargo build`. @@ -64,4 +73,4 @@ There is no releases yet, but clone the repo, cd to the root and run `cargo buil * I am new to rust, so the code i produce is not ferris on wheels, but i will get there eventually. My next round of cleanup is going to be on using `Result` correctly and do proper error handling -Happy hacking! \ No newline at end of file +Happy hacking!