Skip to content

Commit

Permalink
Updated home & added MocKMP
Browse files Browse the repository at this point in the history
  • Loading branch information
SalomonBrys committed Feb 1, 2024
1 parent f2e5e2e commit 8b3d937
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 23 deletions.
14 changes: 6 additions & 8 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ site:
robots: allow
content:
sources:
- url: https://github.com/kosi-libs/documentation.git
branches: master
start_path: home
- url: https://github.com/kosi-libs/Kodein.git
branches: ['7.*', '6.5']
start_path: doc
# - url: https://github.com/kosi-libs/Kodein-DB.git
# branches: ['0.*', '1.*']
# start_path: doc
- url: https://github.com/kosi-libs/Canard.git
branches: ['0.*', '1.*']
start_path: doc
- url: https://github.com/kosi-libs/documentation.git
branches: master
start_path: home
- url: https://github.com/kosi-libs/MocKMP.git
branches: ['1.*']
start_path: doc
ui:
bundle:
url: https://github.com/kosi-libs/documentation-ui/raw/master/build/ui-bundle-v1.3.zip
Expand All @@ -26,8 +26,6 @@ ui:
static_files: [ .nojekyll ]
- path: .nojekyll
urls:
# latest_version_segment_strategy: 'redirect:from'
# latest_version_segment: 'latest'
redirect_facility: 'static'
output:
dir: docs
3 changes: 2 additions & 1 deletion home/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
* xref:kodein::index.adoc[Dependency Injection]
* xref:canard::index.adoc[Multiplatform logging]
* xref:canard::index.adoc[Logging]
* xref:mockmp::index.adoc[Mocking for tests]
44 changes: 30 additions & 14 deletions home/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The *Kodein Open Source Initiative*:
- help you maximize your Kotlin common code, with almost everything but the UI
- and keeps your focus on your business code.
== Libraries

The *Kodein Open Source Initiative* libraries provide:
Expand All @@ -18,7 +19,8 @@ The *Kodein Open Source Initiative* libraries provide:

NOTE: Each library can be used independently of each other.

=== xref:kodein-di:ROOT:index.adoc[Kodein-DI: Dependency Injection]

=== xref:kodein::index.adoc[Kodein-DI: Dependency Injection]

_Kodein-DI_ is a very useful dependency injection / retrieval container, it is very easy to use and configure.

Expand All @@ -36,21 +38,34 @@ _Kodein-DI_ is a very useful dependency injection / retrieval container, it is v
- It proposes a very kotlin-esque idiomatic API.
- It (also) can be used in plain Java.

=== xref:kodein-db:ROOT:index.adoc[Kodein-DB: NoSQL Database]

Kodein DB is a Kotlin/Multiplatform embedded NoSQL database that works on JVM, Android, Kotlin/Native and iOS.
It is suited for client or mobile applications.
=== xref:canard::index.adoc[Canard: Logging]

_Canard_ is a lightweight logging library with a simple API.

._Canard_ allows you to:
- Easily set up logging in a Kotlin Multiplatform project.
- Log what you need on different levels.
- Avoid worrying about platform-specific frontend implementations.

._Canard_ is a good choice because:
- It integrates nicely with all Kotlin/Multiplatform targets.
- It has a straightforward design with a user-friendly and comprehensible API.

.Kodein-DB allows you to:
- Easily store, retrieve and query kotlin objects.
- Stop carrying about schema definitions.
- Easily set up a new project.

.Kodein-DB is a good choice because it:
- proposes a very simple and readable DSL.
- integrates nicely with Android and iOS.
- offers very good performances.
- is just Kotlin!
=== xref:mockmp::index.adoc[MocKMP: Mocking for tests]

_MocKMP_ is a Kotlin Symbol Processor that generates Mocks & Fakes for your test classes.

._MocKMP_ allows you to:
- Generate interface mocks & configure their behaviour.
- Instantiate data classes with fake data.
- Verify calls in order and exhaustively.

._MocKMP_ is a good choice because:
- It mimics, as much as possible, the API of other JVM-only mocking frameworks.
- It offers a clean and easy-to-understand API


== Support

Expand All @@ -59,10 +74,11 @@ If you need any help do not hesitate to through questions or issues:
- Drop by the https://kotlinlang.slack.com/messages/kodein/[Kodein Slack channel]
- https://stackoverflow.com/questions/tagged/kodein[Stackoverflow] with the tag #kodein


== Contribute

Contributions are very welcome and greatly appreciated! The great majority of pull requests are eventually merged.

To contribute, simply fork any of https://github.com/kosi-libs/[our projects on Github], fix whatever is iching you, and submit a pull request!

We are sure that there is still room for imporvement, either in code or documentation.
We are sure that there is still room for improvement, either in code or documentation.

0 comments on commit 8b3d937

Please sign in to comment.