Skip to content

Commit

Permalink
docs: update readme (anuraghazra#1721)
Browse files Browse the repository at this point in the history
This pull request fixes several syntax errors in the readme that might confuse people.
  • Loading branch information
chhajedji authored May 1, 2022
1 parent de05a57 commit f7ddcbe
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The implementation can be investigated at [src/calculateRank.js](./src/calculate

### Hiding individual stats

To hide any specific stats, you can pass a query parameter `?hide=` with comma-separated values.
To hide any specific stats, you can pass a query parameter `&hide=` with comma-separated values.

> Options: `&hide=stars,commits,prs,issues,contribs`
Expand All @@ -116,7 +116,7 @@ To hide any specific stats, you can pass a query parameter `?hide=` with comma-s

### Adding private contributions count to total commits count

You can add the count of all your private contributions to the total commits count by using the query parameter `?count_private=true`.
You can add the count of all your private contributions to the total commits count by using the query parameter `&count_private=true`.

_Note: If you are deploying this project yourself, the private contributions will be counted by default. Otherwise, you need to choose to share your private contribution counts._

Expand Down Expand Up @@ -266,15 +266,15 @@ Endpoint: `api/top-langs?username=anuraghazra`

### Exclude individual repositories

You can use `?exclude_repo=repo1,repo2` parameter to exclude individual repositories.
You can use `&exclude_repo=repo1,repo2` parameter to exclude individual repositories.

```md
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io)](https://github.com/anuraghazra/github-readme-stats)
```

### Hide individual languages

You can use `?hide=language1,language2` parameter to hide individual languages.
You can use `&hide=language1,language2` parameter to hide individual languages.

```md
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)](https://github.com/anuraghazra/github-readme-stats)
Expand Down

0 comments on commit f7ddcbe

Please sign in to comment.