From 160bea7a11ee17e58200f73ee6d0e2adc532aed1 Mon Sep 17 00:00:00 2001 From: David Denton Date: Thu, 10 Oct 2024 13:13:35 +0100 Subject: [PATCH] Add installation --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 21653215..8e869d81 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,23 @@ Although centered around usage in http4k-based projects, http4k-connect does not ## Rationale Although convenient, many API Client libraries introduce many heavyweight dependencies or contain a plethora of non-required functionality, which can have a large effect on binary size. As an alternative, http4k-connect provides lightweight versions of popular APIs covering standard use-cases. +### Installation +```kotlin +dependencies { + // install the platform... + implementation(platform("org.http4k:http4k-connect-bom:5.25.0.0")) + + // ...then choose an API Client + implementation("org.http4k:http4k-connect-amazon-s3") + + // ...and a storage backend (optional) + implementation("org.http4k:http4k-connect-storage-redis") + + // ...a fake for testing (optional) + testImplementation("org.http4k:http4k-connect-amazon-s3-fake") +} +``` +
## About the docs