Skip to content

Commit

Permalink
style checking the code base before run tests (#87)
Browse files Browse the repository at this point in the history
* style checking the code base before run tests

* writed in README - run style check

* move checking style in check job
  • Loading branch information
ArtemIsmagilov authored Dec 21, 2024
1 parent 950bc71 commit afbde24
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/compile_and_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ jobs:
uses: actions/checkout@v4
- name: Run cargo check
run: cargo check
- name: Checking style
run: cargo fmt --all -- --check

test:
name: Test
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
An asynchronous Redis client for Rust.


[![Crate](https://img.shields.io/crates/v/rustis.svg)](https://crates.io/crates/rustis)
[![docs.rs](https://docs.rs/rustis/badge.svg)](https://docs.rs/rustis)
[![Build](https://github.com/dahomey-technologies/rustis/actions/workflows/compile_and_test.yml/badge.svg)](https://github.com/dahomey-technologies/rustis/actions/workflows/compile_and_test.yml)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

# Documentation

[Official Documentation](https://docs.rs/rustis/latest/rustis/)

# Philosophy

* Low allocations
* Full async library
* Lock free implementation
* Rust idiomatic API
* Multiplexing as a core feature

# Features

* Full documentation with multiple examples
* Support all [Redis Commands](https://redis.io/commands/) until Redis 7.0
* Async support ([tokio](https://tokio.rs/) or [async-std](https://async.rs/))
Expand Down Expand Up @@ -74,7 +76,9 @@ async fn main() -> Result<()> {
1. From the `redis` directory, run `docker_up.sh` or `docker_up.cmd`
2. run `cargo test --features pool,redis-stack,tokio-tls` (Tokio runtime)
3. run `cargo test --no-default-features --features redis-stack,async-std-runtime,async-std-tls` (async-std runtime)
4. run `cargo fmt --all -- --check`

# Benchmarks

1. From the `redis` directory, run `docker_up.sh` or `docker_up.cmd`
2. run `cargo bench`

0 comments on commit afbde24

Please sign in to comment.