Skip to content

Commit

Permalink
doc: tweak options wording
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan13888 committed May 31, 2021
1 parent d82eba1 commit 3644aa0
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ Also, **VBR features could be configured as a [HTTP query parameter](https://en.
### Options (add as a [HTTP query parameter](https://en.wikipedia.org/wiki/Query_string))
**IMPORTANT: Other than the `page_id` option, there exists additional styling options and functional options (in the future). More details about the options could be found at the bottom of the [Shields.io website](https://shields.io/). Also, all the options are specified as HTTP parameters!!!**
- `page_id=<your id>` --> identifies your badge, make this unique to yourself. eg. `<your username.visitor.badge.reloaded` or `<username>-<username>`
- `color=<colour here>` --> the hex colour code of your badge, **do NOT include the `#`**
- `lcolor=<colour here>` --> set the left colour of the badge, **do NOT include the `#`**
- `color=<colour here>` --> the hex colour of the text background, **do NOT include the `#`**
- `lcolor=<colour here>` --> the hex colour of the label background, **do NOT include the `#`**
- `style=<style name>` --> refer to the Sheilds.IO website for the available options
- `text=<Some text other than "Visitors">` --> put a customizable label on your badge
- `logo` --> logo to put beside the badge, go to https://simpleicons.org/ for the available names
Expand All @@ -78,6 +78,7 @@ This app could be packaged as a Docker image. Prebuilt docker images of VBR are
Heroku supports Docker containers even with their free dynos. __The current public instance of the app is deployed there as well. __Documentation for deploying Docker is found [here](https://devcenter.heroku.com/articles/build-docker-images-heroku-yml). **All the files necessary to deploy to Heroku is already present** within the repository __so this should be rather trivial__. In addition `make deploy-heroku` pushes the git repo to the `heroku` remote if you have configured Heroku already.

You could also deploy to heroku using this widget (thanks to [rzlamrr](https://github.com/rzlamrr) for the PR):

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## "Stuff" Used
Expand Down

0 comments on commit 3644aa0

Please sign in to comment.