Update README for 4.0.1 #165
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kbaum
commented
Jan 13, 2019
| # Installation | ||
|
|
||
| Coverband should be near zero config for Rails apps, if you have an issue with that, please [file an issue](https://github.com/danmayer/coverband/issues). | ||
| ## Redis |
There was a problem hiding this comment.
Thought we could use mention of redis a bit earlier since it is required.
kbaum
commented
Jan 13, 2019
| @@ -132,18 +104,6 @@ end | |||
|
|
|||
| Take Coverband for a spin on the live Heroku deployed [Coverband Demo](https://coverband-demo.herokuapp.com/). The [full source code for the demo](https://github.com/danmayer/coverband_demo) is available to help with installation, configuration, and understanding of basic usage. | |||
|
|
|||
| # How To Use | |||
There was a problem hiding this comment.
Feel like this section might be not needed anymore as it is covered elsewhere.
kbaum
commented
Jan 13, 2019
| @@ -185,6 +145,8 @@ You may need to configure Coverband you can either do that passing in all config | |||
| ```ruby | |||
| #config/coverband.rb | |||
| Coverband.configure do |config| | |||
| config.store = Coverband::Adapters::RedisStore.new(Redis.new(url: ENV['MY_REDIS_URL'])) | |||
There was a problem hiding this comment.
Added some more typical configuration settings since now s3 is something that will most often not be needed.
kbaum
commented
Jan 13, 2019
| This should auto-open in your browser, but if it doesn't the output file should be in `coverage/index.html` | ||
|
|
||
| ## Viewing the Report in App | ||
| # Coverage Report |
There was a problem hiding this comment.
Tried to simplify the code example here.
danmayer
reviewed
Jan 18, 2019
README.md
Outdated
| <a href="#coverband-demo">Coverband Demo</a> • | ||
| <a href="#how-to-use">How To Use</a> • | ||
| <a href="#coverage-report">Coverage Report</a> • | ||
| <a href="#coverage-report">Coverage Report</a> • |
There was a problem hiding this comment.
duplicate coverage report line?
danmayer
approved these changes
Jan 18, 2019
| # Installation | ||
|
|
||
| Coverband should be near zero config for Rails apps, if you have an issue with that, please [file an issue](https://github.com/danmayer/coverband/issues). | ||
| ## Redis |
| @@ -185,6 +145,8 @@ You may need to configure Coverband you can either do that passing in all config | |||
| ```ruby | |||
| #config/coverband.rb | |||
| Coverband.configure do |config| | |||
| config.store = Coverband::Adapters::RedisStore.new(Redis.new(url: ENV['MY_REDIS_URL'])) | |||
kbaum
force-pushed
the
4_0_1_readme_updates
branch
from
f3259d3
to
707579d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.