Compare commits

...

3 commits

Author SHA1 Message Date
4ce55e73f0
chore: Bump the version to 0.3.0
Some checks failed
Rust CI / Rust CI (push) Failing after 48s
Signed-off-by: Awiteb <a@4rs.nl>
2024-08-12 21:08:14 +00:00
3b957ccfc5
chore: Update README.md
Signed-off-by: Awiteb <a@4rs.nl>
2024-08-12 21:07:55 +00:00
c1e6a76a79
chore!: Rename simple_generator feature to simple-generator
Signed-off-by: Awiteb <a@4rs.nl>
2024-08-12 21:06:32 +00:00
5 changed files with 14 additions and 7 deletions

View file

@ -18,7 +18,7 @@ jobs:
- name: Build the source code - name: Build the source code
run: cargo build run: cargo build
- name: Build examples - name: Build examples
run: cargo build -F 'cacache-storage' --example simple_login run: cargo build -F 'simple-generator' --example simple_login
- name: Run tests - name: Run tests
run: cargo test --tests --all-features run: cargo test --tests --all-features
- name: Check the code format - name: Check the code format

View file

@ -1,6 +1,6 @@
[package] [package]
name = "salvo-captcha" name = "salvo-captcha"
version = "0.2.0" version = "0.3.0"
rust-version = "1.75.0" rust-version = "1.75.0"
edition = "2021" edition = "2021"
authors = ["Awiteb <a@4rs.nl>"] authors = ["Awiteb <a@4rs.nl>"]
@ -35,4 +35,4 @@ rstest = "0.22.0"
[[example]] [[example]]
name = "simple_login" name = "simple_login"
required-features = ["simple_generator"] required-features = ["simple-generator"]

View file

@ -19,7 +19,7 @@ _default:
# Run the CI (Local use only) # Run the CI (Local use only)
@ci: @ci:
cargo fmt --all --check cargo fmt --all --check
cargo build -F 'simple_generator' --example simple_login cargo build -F 'simple-generator' --example simple_login
cargo clippy --workspace --all-targets --examples --tests --all-features -- -D warnings cargo clippy --workspace --all-targets --examples --tests --all-features -- -D warnings
cargo nextest run --workspace --all-targets --all-features cargo nextest run --workspace --all-targets --all-features
@{{JUST_EXECUTABLE}} msrv @{{JUST_EXECUTABLE}} msrv

View file

@ -46,7 +46,14 @@ We provide fully customizable query parameters, form fields, and headers to find
## Captcha Generator ## Captcha Generator
We provide [`SimpleCaptchaGenerator`] which is a simple captcha generator based on the [`captcha`] crate. You can implement your own captcha generator by implementing the [`CaptchaGenerator`] trait. We provide [`SimpleCaptchaGenerator`] which is a simple captcha generator based on the [`captcha`] crate, you can enable it by enabling the `simple-generator` feature.
```toml
[dependencies]
salvo-captcha = { version = "0.2", features = ["simple-generator"] }
```
You can implement your own generator by implementing the [`CaptchaGenerator`] trait.
### Captcha name and difficulty ### Captcha name and difficulty

View file

@ -9,10 +9,10 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE. // THE SOFTWARE.
#[cfg(feature = "simple_generator")] #[cfg(feature = "simple-generator")]
mod simple_generator; mod simple_generator;
#[cfg(feature = "simple_generator")] #[cfg(feature = "simple-generator")]
pub use simple_generator::*; pub use simple_generator::*;
/// Captcha generator, used to generate a new captcha image and answer. /// Captcha generator, used to generate a new captcha image and answer.