README.md in rspeed-0.4.0 vs README.md in rspeed-0.5.0

- old
+ new

@@ -1,11 +1,12 @@ # RSpeed -[![Build Status](https://github.com/wbotelhos/rspeed/workflows/CI/badge.svg)](https://github.com/wbotelhos/rspeed/actions) +[![CI](https://github.com/wbotelhos/rspeed/workflows/CI/badge.svg)](https://github.com/wbotelhos/rspeed/actions) [![Gem Version](https://badge.fury.io/rb/rspeed.svg)](https://badge.fury.io/rb/rspeed) -[![Maintainability](https://api.codeclimate.com/v1/badges/cc5efe8b06bc1d5e9e8a/maintainability)](https://codeclimate.com/github/wbotelhos/rspeed/maintainability) -[![Patreon](https://img.shields.io/badge/donate-%3C3-brightgreen.svg)](https://www.patreon.com/wbotelhos) +[![Maintainability](https://api.codeclimate.com/v1/badges/f312587b4f126bb13e85/maintainability)](https://codeclimate.com/github/wbotelhos/rspeed/maintainability) +[![Coverage](https://codecov.io/gh/wbotelhos/rspeed/branch/main/graph/badge.svg)](https://codecov.io/gh/wbotelhos/rspeed) +[![Sponsor](https://img.shields.io/badge/sponsor-%3C3-green)](https://www.patreon.com/wbotelhos) RSpeed splits your specs to you run parallels tests. ## Install @@ -23,22 +24,25 @@ rake rspeed:install ``` ## Usage -- `RSPEED`: Enables RSpeed -- `RSPEED_PIPES`: Quantity of pipes +- `RSPEED_NAME`: You app name to avoid data override - `RSPEED_PIPE`: Current pipe +- `RSPEED_PIPES`: Quantity of pipes +- `RSPEED_RESULT_KEY`: The key that keeps the final result of all pipes +- `RSPEED_TMP_KEY`: The temporary key that keeps the partial result of the pipes +- `RSPEED`: Enables RSpeed ```sh -RSPEED=true RSPEED_PIPES=3 RSPEED_PIPE=1 bundle exec rake rspeed:run +RSPEED=true RSPEED_NAME=authorizy RSPEED_PIPE=1 RSPEED_PIPES=3 bundle exec rake rspeed:run ``` ## How it Works ### First run -1. Since we has no statistics on the first time, we run all specs and collect it; +1. Since we have no statistics on the first time, we run all specs and collect it; ```json { "file": "./spec/models/1_spec.rb", "time": 0.01 } { "file": "./spec/models/2_spec.rb", "time": 0.02 } { "file": "./spec/models/3_spec.rb", "time": 0.001 }