Skip to content
This repository was archived by the owner on Jan 10, 2023. It is now read-only.

Commit 5db9c69

Browse files
authored
Small format and spelling improvements for README (#108)
1 parent 382240b commit 5db9c69

1 file changed

Lines changed: 22 additions & 16 deletions

File tree

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Codecov Ruby Uploader
22

33
## DEPRECATION WARNING
4-
All versions of the Ruby uploader prior to `0.2.0` will no longer be supported and will be removed from public use on or after *2020-08-17*.
4+
5+
All versions of the Ruby uploader prior to `0.2.0` will no longer be supported
6+
and will be removed from public use on or after *2020-08-17*.
57
Please upgrade to the latest versions to continue using this uploader.
68

79
[![Codecov](https://codecov.io/github/codecov/codecov-ruby/coverage.svg?branch=master)](https://codecov.io/github/codecov/codecov-ruby?branch=master)
8-
[![Gem Version](https://badge.fury.io/rb/codecov.svg)](https://badge.fury.io/rb/codecov.svg)
10+
[![Gem Version](https://badge.fury.io/rb/codecov.svg)](https://rubygems.org/gems/codecov)
911
[![Build Status](https://secure.travis-ci.org/codecov/codecov-ruby.svg?branch=master)](http://travis-ci.org/codecov/codecov-ruby)
1012
[![Codecov](https://circleci.com/gh/codecov/codecov-ruby.svg?style=svg)](https://circleci.com/gh/codecov/codecov-ruby)
1113
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-ruby.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-ruby?ref=badge_shield)
@@ -15,13 +17,13 @@ Please upgrade to the latest versions to continue using this uploader.
1517

1618
## Quick Start
1719

18-
> Add to your `Gemfile`
20+
Add to your `Gemfile`:
1921

2022
```ruby
2123
gem 'codecov', require: false, group: 'test'
2224
```
2325

24-
> Add to the top of your `tests/helper.rb` file
26+
Add to the top of your `tests/helper.rb` file:
2527

2628
```ruby
2729
require 'simplecov'
@@ -31,21 +33,24 @@ require 'codecov'
3133
SimpleCov.formatter = SimpleCov::Formatter::Codecov
3234
```
3335

34-
> In your CI Environment Variables
36+
Add CI Environment Variable:
37+
3538
```sh
3639
CODECOV_TOKEN="your repo token"
3740
```
38-
Find you repo token on your repo page at [codecov.io](https://codecov.io). Repo tokens are **not** required for public repos on Travis-Ci, CircleCI, or AppVeyor CI.
41+
42+
Find you repo token on your repo page at [codecov.io](https://codecov.io).
43+
Repo tokens are **not** required for public repos on Travis-Ci, CircleCI, or AppVeyor CI.
3944

4045
## Supported CIs
4146
| CI/CD |
4247
| ----- |
43-
| [Appveyor CI](https://www.appveyor.com/) |
48+
| [AppVeyor CI](https://www.appveyor.com/) |
4449
| [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) |
4550
| [Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines) |
4651
| [Bitrise CI](https://www.bitrise.io/) |
4752
| [Buildkite CI](https://buildkite.com/) |
48-
| [Codebuild CI](https://aws.amazon.com/codebuild/) |
53+
| [CodeBuild CI](https://aws.amazon.com/codebuild/) |
4954
| [Circle CI](https://circleci.com/) |
5055
| [Codeship CI](https://codeship.com/) |
5156
| [Drone CI](https://drone.io/) |
@@ -72,16 +77,16 @@ end
7277

7378
## Useful Links
7479

75-
[FAQ](https://docs.codecov.io/docs/frequently-asked-questions)
76-
[Recipe List](https://docs.codecov.io/docs/common-recipe-list)
77-
[Error Reference](https://docs.codecov.io/docs/error-reference)
78-
[Changelog](./CHANGELOG.md)
79-
[Support](https://codecov.io/support)
80-
[Community Boards](https://community.codecov.io)
80+
[FAQ](https://docs.codecov.io/docs/frequently-asked-questions)
81+
[Recipe List](https://docs.codecov.io/docs/common-recipe-list)
82+
[Error Reference](https://docs.codecov.io/docs/error-reference)
83+
[Changelog](./CHANGELOG.md)
84+
[Support](https://codecov.io/support)
85+
[Community Boards](https://community.codecov.io)
8186

8287
## Caveats
8388

84-
1. There are known issues when `Simplecov.track_files` is enabled. We recommend that you require all code files in your tests so that Simplecov can provide Codecov with properly mapped coverage report metrics. [codecov/support#133]( https://github.com/codecov/support/issues/133)
89+
1. There are known issues when `Simplecov.track_files` is enabled. We recommend that you require all code files in your tests so that SimpleCov can provide Codecov with properly mapped coverage report metrics. [codecov/support#133]( https://github.com/codecov/support/issues/133)
8590
- https://github.com/colszowka/simplecov/blob/master/README.md#default-root-filter-and-coverage-for-things-outside-of-it
8691
2. `git` must be installed.
8792
- https://github.com/codecov/codecov-ruby/blob/5e3dae3/lib/codecov.rb#L284-L295
@@ -92,7 +97,8 @@ end
9297

9398
## Enterprise
9499

95-
For companies using Codecov Enterprise you will need to specify the following parameters.
100+
For companies using Codecov Enterprise you will need to specify the following parameters:
101+
96102
```sh
97103
CODECOV_URL="https://codecov.mycompany.com"
98104
CODECOV_SLUG="owner/repo"

0 commit comments

Comments
 (0)