From de783f77a2194c737d843e87fb0abb2b5fe8c36d Mon Sep 17 00:00:00 2001 From: InsanusMokrassar Date: Sat, 5 Dec 2020 18:59:28 +0600 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9ce8084f80a..2876c95bb6d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,16 @@ You always can look at the [properties file](https://github.com/InsanusMokrassar -## Structure +## Projects + +* `common` contains common tools for platform which usually are absent out-of-the-box when you starting project +* `coroutines` is a module for `Kotlin Coroutines` with different things like subscribing on flows (`onEach` + `launchIn` shortcut :) ) +* `ktor` is a set of modules for `client`s and `server`s +* `mime_types` is NOT lightweight set of `MimeType`s with a lot of different objected and serializable (with `Kotlin Serialization`) mime types +* `pagination` is a complex of modules (explanation in [Complex modules structure](#complex-modules-structure) section) for lightweight pagination +* `repos` is a complex of modules (explanation in [Complex modules structure](#complex-modules-structure) section) for `KeyValue`/`OneToMany`/`CRUD` repos created to be able to exclude some heavy dependencies when you need some simple and lightweight typical repositories + +## Complex modules structure Most of complex modules are built with next hierarchy: @@ -24,12 +33,3 @@ Most of complex modules are built with next hierarchy: * `common` part contains routes which are common for clients and servers * `client` submodule contains clients which are usually using `UnifiedRequester` to make requests using routes from `ktor/common` module and some internal logic of requests * `server` submodule (in most cases `JVM`-only) contains some extensions for `Route` instances which usually will give opportunity to proxy internet requests from `ktor/client` realization to some proxy object - -## Projects - -* `common` contains common tools for platform which usually are absent out-of-the-box when you starting project -* `coroutines` is a module for `Kotlin Coroutines` with different things like subscribing on flows (`onEach` + `launchIn` shortcut :) ) -* `ktor` is a set of modules for `client`s and `server`s -* `mime_types` is NOT lightweight set of `MimeType`s with a lot of different objected and serializable (with `Kotlin Serialization`) mime types -* `pagination` is a complex of modules (explanation in [Structure](#structure) section) for lightweight pagination -* `repos` is a complex of modules (explanation in [Structure](#structure) section) for `KeyValue`/`OneToMany`/`CRUD` repos created to be able to exclude some heavy dependencies when you need some simple and lightweight typical repositories