diff --git a/README.md b/README.md index fc30578f..3da8ceb9 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,21 @@ YOJ integrates well with YDB, and it also has an in-memory repository implementa lightning-fast persistence tests. YOJ is licensed under [Apache License, Version 2.0](LICENSE). -If you wish to contribute to YOJ, see the [Notice to external contributors](CONTRIBUTING.md). + +If you wish to contribute to YOJ, see the [Notice to external contributors](CONTRIBUTING.md), and follow the [guidelines](GUIDELINES.md). ---- +**To use YOJ in your project**, just add YOJ BOM (Bill of Materials) to your Maven ``: +```xml + + tech.ydb.yoj + yoj-bom + 1.0.0 + pom + import + +``` +Then depend on just the modules you need, specifying only `groupId`=`tech.ydb.yoj` and `artifactId`=`yoj-` (see `` names below). **🦔 YOJ consists of the following modules:** - `databind`: Core data-binding logic used to convert between Java objects and database rows (or anything representable