Skip to content

Commit

Permalink
Merge pull request #8 from silentsoft/dev
Browse files Browse the repository at this point in the history
Bump version from 1.0.0 to 1.1.0
  • Loading branch information
silentsoft authored Feb 24, 2022
2 parents 48f7902 + ff7f10e commit b7f3ab5
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 6 deletions.
106 changes: 106 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# 1.1.0 (25 Feb 2022)

## Enhancements
- Add alt attribute to image tag.

# 1.0.0 (24 Feb 2022)

![](.images/hits-readme.png)

## 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`:

[![Hits](https://hits.sh/github.com/silentsoft/hits.svg)](https://hits.sh/github.com/silentsoft/hits/)

- Markdown
```markdown
[![Hits](https://hits.sh/github.com/silentsoft/hits.svg)](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

![](.images/color-brightgreen.svg)
![](.images/color-green.svg)
![](.images/color-yellow.svg)
![](.images/color-yellowgreen.svg)
![](.images/color-orange.svg)
![](.images/color-red.svg)
![](.images/color-blue.svg)
![](.images/color-grey.svg)
![](.images/color-lightgrey.svg)
![](.images/color-gray.svg)
![](.images/color-lightgray.svg)
![](.images/color-critical.svg)
![](.images/color-important.svg)
![](.images/color-success.svg)
![](.images/color-informational.svg)
![](.images/color-inactive.svg)

- Any valid [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value)
- named color
- ![](.images/color-black.svg)
- ![](.images/color-rebeccapurple.svg)
- etc.
- hexadecimal numbers
- ![](.images/color-ff69b4.svg)
- ![](.images/color-9cf.svg)
- 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/)

![](.images/hits-statistics.png)

## Installation
```
$ git clone https://github.com/silentsoft/hits.git
$ cd hits
$ mvnw spring-boot:run
```

![](.images/hits-screenshot.png)

## Packaging
```
$ mvnw clean package -P production
```
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hits",
"version": "1.0.0",
"version": "1.1.0",
"private": true,
"dependencies": {
"@nivo/calendar": "^0.79.1",
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

<groupId>org.silentsoft</groupId>
<artifactId>hits</artifactId>
<version>1.0.0</version>
<version>1.1.0</version>

<name>Hits</name>
<description>Hit Counter for Your GitHub or Any Kind of Websites You Want</description>
Expand Down
2 changes: 1 addition & 1 deletion src/main/react/Content.js
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ export default function Content(props) {
} else if (!isValidUrl()) {
return INVALID_URL;
}
return `<a href="https://hits.sh/${normalize(url)}/"><img src="https://hits.sh/${normalize(url)}.svg${toQueryString()}"/></a>`;
return `<a href="https://hits.sh/${normalize(url)}/"><img alt="Hits" src="https://hits.sh/${normalize(url)}.svg${toQueryString()}"/></a>`;
};

const toImageLink = () => {
Expand Down
2 changes: 1 addition & 1 deletion src/main/react/terminal/Field.js
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ class Field extends React.Component {
'',
'HTML:',
'',
`\u00A0\u00A0<a href="https://hits.sh/${urn}/"><img src="https://hits.sh/${urn}.svg${query}"/></a>`,
`\u00A0\u00A0<a href="https://hits.sh/${urn}/"><img alt="Hits" src="https://hits.sh/${urn}.svg${query}"/></a>`,
'',
'Image Link:',
'',
Expand Down

0 comments on commit b7f3ab5

Please sign in to comment.