Skip to content

Commit 1ab86d1

Browse files
authored
Merge pull request #154 from codacy/readme-improvements
Small suggestions to improve README.md
2 parents cf8f926 + 14a7033 commit 1ab86d1

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,31 @@ Multi-language coverage reporter for Codacy https://www.codacy.com
1515
Codacy assumes that coverage is previously configured for your project.
1616
The supported coverage formats can be found [here](https://github.com/codacy/coverage-parser).
1717

18-
1. Setup the project API token. You can find the token in Project -> Settings -> Integrations -> Project API.
18+
1. Set up the project API token. You can find the token in Project -> Settings -> Integrations -> Project API.
1919

20-
1. Set it in your terminal, replacing %Project_Token% with your own token:
20+
1. Set the API token in your terminal, replacing %Project_Token% with your own token:
2121

2222
```
2323
export CODACY_PROJECT_TOKEN=%Project_Token%
2424
```
2525

26-
##### Alternative: using an API Token
26+
**As an alternative**, you can use an API Token instead:
2727

28-
1. Setup the Account API token. You can find the token in Your account -> API tokens
28+
1. Set up the Account API token. You can find the token in Your account -> API tokens
2929

30-
1. Set it in your terminal, replacing the %API_Token% with your own token:
30+
1. Set the API token in your terminal, replacing %API_Token% with your own token
3131

32-
1. Set your project name in your terminal, replacing the %Project_Name%
32+
1. Set your project name in your terminal, replacing %Project_Name%
3333

34-
1. Set your username in your terminal, replacing the %Username%
34+
1. Set your username in your terminal, replacing %Username%
3535

3636
```
3737
export CODACY_API_TOKEN=%API_Token%
3838
export CODACY_PROJECT_NAME=%Project_Name%
3939
export CODACY_USERNAME=%Username%
4040
```
4141

42-
### Using the script
42+
### Running Codacy Coverage Reporter with a script
4343

4444
Additional requirements:
4545

@@ -64,7 +64,7 @@ This command assumes the coverage reports follow a name convention:
6464

6565
Otherwise, you must define the report's location with the flag `-r`.
6666

67-
### Using binary manually
67+
### Running Codacy Coverage Reporter by manually downloading the binary
6868

6969
#### Linux amd64
7070

@@ -114,9 +114,9 @@ curl -LS -o codacy-coverage-reporter-assembly.jar "$(curl -LSs https://api.githu
114114
java -jar codacy-coverage-reporter-assembly.jar report -l Java -r jacoco.xml
115115
```
116116

117-
### CommitUUID Detection
117+
### Commit UUID Detection
118118

119-
Codacy automatically detects the CommitUUID from several sources:
119+
Codacy automatically detects the commit UUID from several sources:
120120

121121
**Providers**
122122

@@ -142,9 +142,9 @@ Codacy automatically detects the CommitUUID from several sources:
142142

143143
- If it finds a git directory it will get current commit.
144144

145-
**Force CommitUUID**
145+
**Force commit UUID**
146146

147-
- You may want to enforce a specific commitUUID with:
147+
- You can force using a specific commit UUID with:
148148

149149
```
150150
codacy-coverage-reporter report -l Java --commit-uuid "mycommituuid" -r coverage.xml

0 commit comments

Comments
 (0)