Skip to content

Commit 329cbf0

Browse files
committed
updated: README.md
1 parent 3d4ec43 commit 329cbf0

File tree

1 file changed

+24
-10
lines changed

1 file changed

+24
-10
lines changed

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,36 @@
11
# SteamID
2-
SteamID is an implementation of Valve unique account identifier used to identify Steam accounts
2+
[![Build](https://github.com/rejchev/steamid/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/rejchev/steamid/actions/workflows/ci.yml)
3+
[![](https://jitpack.io/v/rejchev/steamid.svg)](https://jitpack.io/#rejchev/steamid)
4+
![Weekly download statistics](https://jitpack.io/v/rejchev/steamid/week.svg)
5+
[![LICENSE](https://img.shields.io/github/license/rejchev/steamid)](LICENSE)
36

4-
## Getting
5-
### Releases
6-
Download latest `.jar` on [releases](https://github.com/rejchev/steamid/releases/latest)
7+
## Introduction
8+
SteamID is an implementation of Valve unique account identifier used to identify Steam accounts </br>
79

8-
### JitPack
9-
1. Add repository
10-
```maven
10+
The library consists of classes that represents [SteamID](https://developer.valvesoftware.com/wiki/SteamID) </br>
11+
The library also provides registry of converters to convert SteamID representation
12+
13+
14+
## Documentation
15+
Coming soon...
16+
17+
## Usage
18+
19+
### via Releases
20+
Download `.jar` on [releases](https://github.com/rejchev/steamid/releases) or [latest](https://github.com/rejchev/steamid/releases/latest)
21+
22+
### via JitPack
23+
1. Add JitPack repo to your project `pom.xml`
24+
```xml
1125
<repositories>
1226
<repository>
1327
<id>jitpack.io</id>
14-
<url>https://jitpack.io</url>
28+
<url>https://jitpack.io</url>
1529
</repository>
1630
</repositories>
1731
```
18-
2. Add dependency
19-
```maven
32+
2. Add to your dependencies and choose `version`
33+
```xml
2034
<dependency>
2135
<groupId>com.github.rejchev</groupId>
2236
<artifactId>steamid</artifactId>

0 commit comments

Comments
 (0)