added basic docs and added new README
parent
be5fd53a91
commit
76073c8b91
@ -1,3 +1,2 @@
|
||||
.idea/
|
||||
target/
|
||||
docs/
|
||||
target/
|
@ -0,0 +1,2 @@
|
||||
IRCJ (IRC Protocol Wrapper in Java) <BR>
|
||||
===================================
|
@ -0,0 +1,39 @@
|
||||
# Welcome to the IRCJ wiki
|
||||
|
||||
## Installation
|
||||
### Maven
|
||||
Replace **VERSION** with the latest version
|
||||
```xml
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>polarian-repo</id>
|
||||
<url>https://repo.polarian.dev</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
```
|
||||
```xml
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>dev.polarian</groupId>
|
||||
<artifactId>ircj</artifactId>
|
||||
<version>VERSION</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
### Gradle
|
||||
```gradle
|
||||
repositories {
|
||||
maven {
|
||||
url 'https://repo.polarian.dev'
|
||||
}
|
||||
}
|
||||
```
|
||||
```gradle
|
||||
dependencies {
|
||||
implementation 'dev.polarian:ircj:VERSION'
|
||||
}
|
||||
```
|
||||
|
||||
## Support
|
||||
You can contact me through my [email](mailto:polarian@polarian.dev)
|
@ -0,0 +1,5 @@
|
||||
site_name: IRCJ Documentation
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
scheme: slate
|
Loading…
Reference in New Issue