diff --git a/docs/getting-started.md b/docs/getting-started.md index 45e1e497..2810c046 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -6,4 +6,103 @@ nav_order: 2 # Getting Started -To be written. +In this guide, we want to show you how you can easily integrate BigBone into your project. Simply follow the steps below. + +## Adding BigBone to Your Project + +BigBone consists of two main modules: + +1. `bigbone` which exposes the Mastodon API endpoints as handy methods usable via a `MastodonClient` +2. `bigbone-rx` which adds a thin RxJava3 layer around the `bigbone` module + +{: .note } +If your application does not require reactive functionality, you can omit the `bigbone-rx` dependency in the following +steps. BigBone uses RxJava for implementing the reactive part. Check out [their website](https://github.com/ReactiveX/RxJava) +to get more information. + +### Gradle (Groovy DSL) + +Instructions for adding BigBone `2.0.0-SNAPSHOT` to your Gradle project (using Groovy DSL): + +Repository: + +```groovy +repositories { + maven { + url "https://s01.oss.sonatype.org/content/repositories/snapshots/" + } +} +``` + +Dependencies: + +```groovy +dependencies { + implementation "social.bigbone:bigbone:2.0.0-SNAPSHOT" + // Optional, if you want to use the BigBone RxJava3 wrappers + implementation "social.bigbone:bigbone-rx:2.0.0-SNAPSHOT" +} +``` + +### Gradle (Kotlin DSL) + +Instructions for adding BigBone `2.0.0-SNAPSHOT` to your Gradle project (using Kotlin DSL): + +Repository: + +```groovy +repositories { + maven { + url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/") + } +} +``` + +Dependencies: + +```groovy +dependencies { + implementation("social.bigbone:bigbone:2.0.0-SNAPSHOT") + // Optional, if you want to use the BigBone RxJava3 wrappers + implementation("social.bigbone:bigbone-rx:2.0.0-SNAPSHOT") +} +``` + +### Maven + +Instructions for adding BigBone `2.0.0-SNAPSHOT` to your Maven project: + +Repository: + +```xml + + + maven-central-snapshots + Maven Central Snapshot Repository + https://s01.oss.sonatype.org/content/repositories/snapshots/ + + false + + + true + + + +``` + +Dependencies: + +```xml + + social.bigbone + bigbone + 2.0.0-SNAPSHOT + + + + + social.bigbone + bigbone-rx + 2.0.0-SNAPSHOT + +```