Skip to content

Commit a8ba51e

Browse files
committed
Polished readme
* more focus on how to contribute and the wiki * less focus on maven/gradle downloads (they are kinda obsolete for this project anyways)
1 parent 6feb468 commit a8ba51e

File tree

1 file changed

+10
-43
lines changed

1 file changed

+10
-43
lines changed

README.md

Lines changed: 10 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -13,50 +13,17 @@ TJ-Bot is a Discord Bot used on the [Together Java](https://discord.com/invite/X
1313

1414
# Getting started
1515

16-
* [Documentation](https://github.com/Together-Java/TJ-Bot/wiki): as general entry point to the project
17-
* [Contributing](https://github.com/Together-Java/TJ-Bot/wiki/Contributing): if you want to improve the bot
16+
Please read [Contributing](https://github.com/Together-Java/TJ-Bot/wiki/Contributing) if you want to propose ideas and changes or even implement some yourself.
1817

19-
# Download
18+
Head over to the [Wiki](https://github.com/Together-Java/TJ-Bot/wiki) as general entry point to the project. It provides lots of tutorials, documentation and other information, for example
19+
* creating a discord bot and a private server;
20+
* setting up the project locally;
21+
* adding your own custom commands;
22+
* a technology overview;
23+
* guidance about how to maintain the bot (e.g. VPS, logs, databases, restart).
2024

21-
## Using a build tool
22-
23-
### Gradle
24-
25-
First add the jitpack repository:
26-
```gradle
27-
repositories {
28-
maven { url 'https://jitpack.io' }
29-
}
30-
```
31-
Then add the dependency:
32-
```gradle
33-
dependencies {
34-
implementation 'com.github.Together-Java:TJ-Bot:<tag>'
35-
}
36-
```
37-
You can replace `<tag>` by either a commit hash (the first 10 characters) or by `-SNAPSHOT` to get the latest version.
38-
39-
### Maven
40-
41-
First add the jitpack repository:
42-
```xml
43-
<repository>
44-
<id>jitpack.io</id>
45-
<url>https://jitpack.io</url>
46-
</repository>
47-
```
48-
Then add the dependency:
49-
```xml
50-
<dependency>
51-
<groupId>com.github.Together-Java</groupId>
52-
<artifactId>TJ-Bot</artifactId>
53-
<version>[tag]</version>
54-
</dependency>
55-
```
56-
You can replace `[tag]` by either a commit hash (the first 10 characters) or by `-SNAPSHOT` to get the latest version.
57-
58-
---
59-
60-
## Jar downloads
25+
# Download
6126

6227
Jar downloads are available from the [release section](https://github.com/Together-Java/TJ-Bot/releases).
28+
29+
Alternatively, you can also download the project using your favorite build tool. Artifacts are made available via https://jitpack.io. Our `groupId` is `com.github.Together-Java`, the `artifactId` is `TJ-Bot`.

0 commit comments

Comments
 (0)