jillesvangurp / kt-search

Multi platform kotlin client for Elasticsearch & Opensearch with easily extendable Kotlin DSLs for queries, mappings, bulk, and more.
MIT License
112 stars 24 forks source link

Add maven dependencies declaration docs #128

Closed dybarsky closed 8 months ago

dybarsky commented 8 months ago

Gradle allows to include all artefacts from group, but maven doesn't. That means, it's needed to specify all jvm targeting artefacts explicitly as dependencies. Adding this part to documentation, so people who don't know much about kotlin multiplatform internals may find it easier to add dependency into project

dybarsky commented 8 months ago

@jillesvangurp thanks

dybarsky commented 8 months ago

@jillesvangurp I have a question. I realized README.md was not updated after merge. Do I need to do something extra to generate new readme file and than commit it as a separate PR? Or is it being updated automatically?

jillesvangurp commented 8 months ago

Ah right, you should have run the tests in docs to regenerate the README before creating the PR. No problem, I just re-ran that and pushed the changes.