add documentation

README.md

@@ -1 +1,35 @@
 # firetail-java-lib
+
+## Building the library
+
+1. In the projects root folder, run `./gradlew build -x test`
+2. Run `./gradlew publishToMavenLocal`
+
+### Springboot configuration
+1. In `build.gradle.kts` (if you are using kotlin configuration), add within `dependencies {}`, the firetail library:
+
+```
+dependencies {
+    implementation("com.github.firetail-io:firetail-java-lib:$version")
+}
+```
+2. Also in `build.gradle.kts` add below the `plugins {}`:
+
+```
+group = "com.github.firetail-io"
+version = "0.0.1-SNAPSHOT"
+```
+
+3. In your springboot project, add `application.yml` in `build/resources`
+
+```yaml
+firetail:
+  apikey: "PS-02....441b09761c3"
+  url: "https://your-apiapi.logging.eu-north-west-99.sandbox.firetail.app"
+  ## Cache control before dispatching logs to API
+  buffer:
+    # Millis
+    interval: 100000
+    # Max capacity
+    capacity: 5
+```