Skip to content

Commit 6f7a514

Browse files
committed
Update README.md
1 parent 8fc2e86 commit 6f7a514

1 file changed

Lines changed: 40 additions & 2 deletions

File tree

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,50 @@
55
[![Codacy](https://api.codacy.com/project/badge/Grade/087ddd3689bf4ad08d383f52a9936708)](https://www.codacy.com/app/iAmGio/pokedex-java-api?utm_source=github.com&utm_medium=referral&utm_content=iAmGio/pokedex-java-api&utm_campaign=Badge_Grade) [![CodeFactor](https://www.codefactor.io/repository/github/iamgio/pokedex-java-api/badge)](https://www.codefactor.io/repository/github/iamgio/pokedex-java-api)
66

77
# Pokédex Java API
8-
_pokedex-java-api_ is the first wrapper for [pokeapi.co](https://pokeapi.co) written in pure Java.
8+
_pokedex-java-api_ is the first wrapper for [pokeapi.co](https://pokeapi.co) written in pure Java.
9+
910
# Why should I use PDJ API?
1011
- [x] Fully documented
1112
- [x] Everything is treated as an object
1213
- [x] Mantainable and readable code
1314

15+
# Maven
16+
17+
```xml
18+
<repositories>
19+
<repository>
20+
<id>jitpack.io</id>
21+
<url>https://jitpack.io</url>
22+
</repository>
23+
</repositories>
24+
25+
<dependencies>
26+
<dependency>
27+
<groupId>com.github.iAmGio</groupId>
28+
<artifactId>pokedex-java-api</artifactId>
29+
<version>VERSION</version>
30+
</dependency>
31+
</dependencies>
32+
```
33+
34+
# Gradle
35+
36+
```groovy
37+
repositories {
38+
maven {
39+
url 'https://jitpack.io'
40+
}
41+
}
42+
43+
dependencies {
44+
implementation 'com.github.iAmGio:pokedex-java-api:VERSION'
45+
}
46+
```
47+
48+
# Manual / JAR
49+
50+
JAR files can be found in the [releases](https://github.com/iAmGio/pokedex-java-api/releases) tab.
51+
1452
# Getting started
1553

1654
To get started, let's try to get the types of [Bulbasaur](https://www.pokemon.com/us/pokedex/bulbasaur):
@@ -45,4 +83,4 @@ FlavorList<Version> flavors = ...;
4583
String englishStringFromPearl = flavors.filterVersion(Version.PEARL).get(Language.ENGLISH);
4684
```
4785

48-
_This project is currently work in progress. Once finished, the JAR file will be released. At the moment you're free to clone this repository and use it as you wish. Credits to this project and to pokeapi.co are appreciated._
86+
_Credits to this project and to pokeapi.co are appreciated._

0 commit comments

Comments
 (0)