Skip to content

Commit af642d2

Browse files
committed
doc: fix readme typos
1 parent 1c0971f commit af642d2

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1-
# Autometrics Metrics Report
1+
# Autometrics Report
22

3-
A Github action that comments on PRs to tell you how metrics are going to be affected. The
4-
report tells you immediately if your new feature is well instrumented, and shows a useful
5-
summary of the metrics that will be reported without needing to go through the diff.
3+
This Github action will comment on Pull Requests to tell you how metrics are
4+
going to be affected.
65

7-
<!-- Put a screen shot of the PR comment here. -->
6+
The report tells you immediately if your new feature is well instrumented, and
7+
shows a useful summary of the metrics that will be reported without needing to
8+
go through the diff.
9+
10+
![An example of generated report on Github](./assets/comment_preview.png)
811

912
## Inputs
1013

1114
- `gh-token`: a github token that gives access to
1215
+ the PR
1316
+ the repo
1417
+ read/write access to comments on issues/PR
18+
1519
**The built-in `${{ secrets.GITHUB_TOKEN }}` will work, you do not need to create a new one.**
1620
To make the built-in token work, the job must be given a specific set of permissions. The permissions added in the
1721
["Example Usage" section](#example-usage) show the minimal set of permissions needed.
@@ -116,7 +120,7 @@ Look at the issues in the repository to see the advancement of language support.
116120
All languages in the table will be eventually supported.
117121
118122
Language | Support
119-
:---:|:---:|:---:
123+
:---:|:---:
120124
[Rust](https://github.com/autometrics-dev/autometrics-rs) | ✅
121125
[Typescript](https://github.com/autometrics-dev/autometrics-ts) | ❌
122126
[Go](https://github.com/autometrics-dev/autometrics-go) | ❌

assets/comment_preview.png

104 KB
Loading

0 commit comments

Comments
 (0)