starred/github-profile-views-counter
1
0
Fork 0
mirror of https://github.com/antonkomarev/github-profile-views-counter.git synced 2026-07-28 00:12:31 -04:00
Code Issues 24 Packages Projects Releases Wiki Activity

Cleanup readme

Browse Source
This commit is contained in:
antonkomarev
2020-07-18 15:19:08 +03:00
parent 33b968f00a
commit 113f93dbf9
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -10,22 +10,26 @@ It counts how many times your GitHub profile has been viewed and displays them i
Cloud solution launched as 100% free experience. You can [help me cut server costs] if you like this service.
Create your GitHub Profile repository. GitHub magic will happen as soon as you will create a new repository named equally to your username.
### Create GitHub profile repository
GitHub magic will happen as soon as you will create a new repository named equally to your username.
![](https://user-images.githubusercontent.com/1849174/87251639-cbf0e000-c475-11ea-9c69-7600c78ebe33.png)
My profile repository: [https://github.com/antonkomarev/antonkomarev](https://github.com/antonkomarev/antonkomarev)
### Add counter to GitHub profile
You need to add counter in README.md file in your profile repository via Markdown syntax:
```markdown
![](https://komarev.com/ghpvc/?username=your-github-username)
```
> Don't forget to replace example `username` parameter with real value
> **NOTE**: Don't forget to replace example `username` parameter with real value.
GitHub will proxy this URL via its _camo_ service, so it will look like [https://camo.githubusercontent.com/a9aa69b588bef281647d53091b4faa01ac126121/68747470733a2f2f6b6f6d617265762e636f6d2f67687076632f3f757365726e616d653d616e746f6e6b6f6d6172657626](https://camo.githubusercontent.com/a9aa69b588bef281647d53091b4faa01ac126121/68747470733a2f2f6b6f6d617265762e636f6d2f67687076632f3f757365726e616d653d616e746f6e6b6f6d6172657626).
That means I can't track any personal information like User Agent or IP address. Only views counters & timestamp of views are stored.
> GitHub will proxy this URL via its _camo_ service, so it will look like [https://camo.githubusercontent.com/a9aa69b588bef281647d53091b4faa01ac126121/68747470733a2f2f6b6f6d617265762e636f6d2f67687076632f3f757365726e616d653d616e746f6e6b6f6d6172657626](https://camo.githubusercontent.com/a9aa69b588bef281647d53091b4faa01ac126121/68747470733a2f2f6b6f6d617265762e636f6d2f67687076632f3f757365726e616d653d616e746f6e6b6f6d6172657626).
> That means I can't track any personal information like User Agent or IP address. Only views counters & timestamp of views are stored.
## License