From 33b968f00afe46441c874129555d75140b9d6f27 Mon Sep 17 00:00:00 2001 From: antonkomarev Date: Sat, 18 Jul 2020 15:14:41 +0300 Subject: [PATCH] Cleanup readme --- README.md | 31 ++++++++----------------------- 1 file changed, 8 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 761c0f4..819232c 100644 --- a/README.md +++ b/README.md @@ -8,45 +8,30 @@ It counts how many times your GitHub profile has been viewed and displays them i ## Usage +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. ![](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) -### Cloud application - 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` with your own +> Don't forget to replace example `username` parameter with real value -This service launched as experiment. It is completely free. You can [help me cut server costs](https://paypal.me/antonkomarev) if you like this service. I don't track any personal information since GitHub proxies all images. - -### Self-hosted application - -Only `public/index.php` should be exposed. - -You need to host this app on your server and display it via Markdown syntax: - -```markdown -![](https://your.application.path/?username=your-github-username) -``` - -This URL will render SVG image with profile views counter and will increment it on each view of your profile. - -#### Self-hosted application customization - -By default, this application using file repository, visits log stored in `storage/{$username}-views` and counter stored in `storage/{$username}-views-count` file. - -You can switch to database repository, then you will have to copy `.env.example` file to `.env` and fill in database configuration. +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 - `GitHub Profile Views Counter` application is open-sourced software licensed under the [MIT license](LICENSE) by [Anton Komarev]. -- `Eye Octicon` hero image licensed under MIT license by [GitHub, Inc](https://github.com). +- `Eye Octicon` hero image licensed under MIT license by [GitHub, Inc]. [Anton Komarev]: https://komarev.com +[GitHub, Inc]: https://github.com +[help me cut server costs]: https://paypal.me/antonkomarev