Skip to content
This repository was archived by the owner on Apr 9, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ changelog:
- title: 🔄 Dependencies
labels:
- dependencies
- title: 🐘 Gradle
labels:
- gradle
- title: 🤖 GitHub Actions
labels:
- action
Expand Down
57 changes: 47 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ClashJ
# ClashJ

![GitHub top language](https://img.shields.io/github/languages/top/MaicolAntali/clashJ?style=flat-square&logo=kotlin&logoColor=%23FFFFFF)
[![License](https://img.shields.io/github/license/MaicolAntali/ClashJ?style=flat-square&color=%23009E60)](https://github.com/MaicolAntali/clashJ/blob/main/LICENSE.txt)
Expand All @@ -20,23 +20,56 @@ ClashJ is a fully asynchronous Clash of Clans API wrapper, written in Kotlin.
The library required **Java 17** or higher versions.

### Download with Gradle
```gradle
```

1. Add it in your root `build.gradle`e at the end of repositories:
```gradle
repositories {
// ...
maven { url 'https://jitpack.io' }
}
```

2. Add the dependency
```gradle
dependencies {
implementation 'com.github.MaicolAntali:clashJ:main-SNAPSHOT'
}
```

### Download with Maven
```xml
```

1. Add it in your root `pom.xml` at the end of repositories:
```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
```

2. Add the dependency
```xml
<dependency>
<groupId>com.github.MaicolAntali</groupId>
<artifactId>clashJ</artifactId>
<version>main-SNAPSHOT</version>
</dependency>
```

### Usage Example

Simple example of the library usage:

```kotlin
fun main() = runBlocking {
// Build a client with the default option
val client = ClientBuilder("email", "password").build()

// Retrive player info
val player = client.getPlayer("#tag")
println("Name: ${player.name}, TH lvl: ${player.townHallLevel}")

// Retrive clan info
val clan = client.getClan("#tag")
println("Name: ${clan.name}, Tag: ${clan.tag}")
Expand All @@ -45,19 +78,23 @@ fun main() = runBlocking {

## 🔗Links

- [clashJ documentation]()
- [clashJ documentation](https://javadoc.jitpack.io/com/github/MaicolAntali/clashJ/main-SNAPSHOT/javadoc/)

## ✅ Contributing

Thank you for considering contributing to clashJ!

Here's how you can contribute:

1. **Check for Issues**: See if there's an existing issue or feature request related to your contribution. If not, create a new one, so we can discuss it.
1. **Check for Issues**: See if there's an existing issue or feature request related to your contribution.
If not, create a new one, so we can discuss it.
2. **Fork & Branch**: Fork the repository and create a new branch for your changes.
3. **Code**: Write your code following the Kotlin coding standards.
4. **Tests are Awesome**: If you're adding new features, don't forget to include tests.
5. **Pull Request**: Submit a pull request with a brief description of your changes.

## Disclaimer
This content is not affiliated with, endorsed, sponsored, or specifically approved by Supercell and Supercell is not responsible for it.

This content is not affiliated with, endorsed, sponsored, or specifically approved by Supercell and Supercell is not
responsible for it.
For more information, see [Supercell's Fan Content Policy](https://supercell.com/en/fan-content-policy/).