InsanusMokrassar/SDI
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/SDI.git synced 2024-12-28 03:27:23 +00:00
Code Issues Projects Releases Wiki Activity

fill README

Browse Source
This commit is contained in:
InsanusMokrassar 2019-11-27 22:25:19 +06:00
parent 376d29046f
commit 4103aebaad
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,2 +1,29 @@
# SDI
It is simple (in comparison with other systems) DI, which aim to be compatible and predictable.
## Availability platforms
* [x] JVM
* [ ] JS
* [ ] Native
## Required environment
To use this library you will need two things:
* Json serializer
* Json config
Unfortunately, currently not supported other formats (due to
[issue in Kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization/issues/615))
## Rules
Full examples of usage you can find in [tests](src/commonTest/kotlin/com/insanusmokrassar/sdi). In two words, there are
a few rules for constructing of config:
* Config root is an Json Object
* Config root names will be used as dependency names
* In the config dependency names can be used everywhere
* In places, where dependency will be injected, must be used `@ContextualSerializer` annotation or `@Serializer(ContextSerializer::class)`