-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
48f7902
commit 2e966a0
Showing
1 changed file
with
101 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| # 1.0.0 (24 Feb 2022) | ||
|
|
||
|  | ||
|
|
||
| ## Getting Started | ||
| `Hits` supports the following three of the most common use cases: `Markdown`, `HTML` and `Image Link`. | ||
|
|
||
| For example, to get a hits badge for `https://github.com/silentsoft/hits`: | ||
|
|
||
| [](https://hits.sh/github.com/silentsoft/hits/) | ||
|
|
||
| - Markdown | ||
| ```markdown | ||
| [](https://hits.sh/github.com/silentsoft/hits/) | ||
| ``` | ||
| - HTML | ||
| ```html | ||
| <a href="https://hits.sh/github.com/silentsoft/hits/"><img src="https://hits.sh/github.com/silentsoft/hits.svg"/></a> | ||
| ``` | ||
| - Image Link | ||
| ``` | ||
| https://hits.sh/github.com/silentsoft/hits.svg | ||
| ``` | ||
|
|
||
| ## Features in Query String | ||
|
|
||
| ### view | ||
| - `total` (default) | ||
| - `today-total` | ||
|
|
||
| ### style | ||
| - `flat` (default) | ||
| - `flat-square` | ||
| - `for-the-badge` | ||
| - `plastic` | ||
|
|
||
| ### label | ||
| - For setting the label text instead of the default `hits`. | ||
|
|
||
| ### extraCount | ||
| - This is useful if you want to add an extra count to your badge. For example, if you want to add a count of `1000` to your badge, you can set `extraCount=1000`. | ||
| - **When Do I Need This?** | ||
| - If the hit counter service you used previously has end-of-service, you can start with any number instead of starting from 1. | ||
|
|
||
| ### color, labelColor | ||
| - Named color by shields.io | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| - Any valid [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) | ||
| - named color | ||
| -  | ||
| -  | ||
| - etc. | ||
| - hexadecimal numbers | ||
| -  | ||
| -  | ||
| - etc. | ||
| - rgb[a](red, green, blue[, opacity]) | ||
| - cmyk[a](cyan, magenta, yellow, black[, opacity]) | ||
| - hsl[a](hue, saturation, lightness[, opacity]) | ||
|
|
||
| ### logo | ||
| - [simple-icons slug](https://github.com/simple-icons/simple-icons/blob/develop/slugs.md) | ||
| - or data:image/svg+xml;base64,.. | ||
|
|
||
| ## Statistics | ||
| You can see the statistics of your website by replacing the `.svg` with `/` in the URL you used to get the badge. | ||
|
|
||
| For example, to get a statistics for `https://github.com/silentsoft/hits` then visit [https://hits.sh/github.com/silentsoft/hits/](https://hits.sh/github.com/silentsoft/hits/) | ||
|
|
||
|  | ||
|
|
||
| ## Installation | ||
| ``` | ||
| $ git clone https://github.com/silentsoft/hits.git | ||
| $ cd hits | ||
| $ mvnw spring-boot:run | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ## Packaging | ||
| ``` | ||
| $ mvnw clean package -P production | ||
| ``` |