diff --git a/index.md b/index.md index 511c427..b408d27 100644 --- a/index.md +++ b/index.md @@ -1,41 +1,56 @@ --- _layout: landing +title: Welcome! --- -Welcome! This project implements the [relational document](/) concepts for Java, Kotlin, Scala, and Groovy applications. +Welcome! This project implements the [relational document](/) concepts for Java, Kotlin, Scala, and Groovy applications. It uses four different modules to provide an idiomatic developer experience across four major JVM languages. -## Modules +## Depend on Them The coordinate structure for these packages is ```xml solutions.bitbadger.documents -[package] +[module] 1.0.0-RC1 ``` -### solutions.bitbadger.documents.core - -![Maven Central Version](https://img.shields.io/maven-central/v/solutions.bitbadger.documents/core) +### core   [![Maven Central Version][core-badge]][core-mvn] This module does most of the heavy lifting for all languages. It provides an optimal Java experience and an optimal Kotlin experience when using a reflection-based JSON serializer. Queries that can return one-or-none return an `Optional` instance. This module also has Kotlin extensions on the JDBC `Connection` type -### solutions.bitbadger.documents.groovy - -![Maven Central Version](https://img.shields.io/maven-central/v/solutions.bitbadger.documents/groovy) +### groovy   [![Maven Central Version][groovy-badge]][groovy-mvn] This far-out module provides Groovy-style extension methods on the `Connection` type. (Right on!) -### solutions.bitbadger.documents.scala - -![Maven Central Version](https://img.shields.io/maven-central/v/solutions.bitbadger.documents/scala) +### scala   [![Maven Central Version][scala-badge]][scala-mvn] This module provides a native Scala API for this library, using its collection types instead of the default Java collections, and returns the Scala `Option[A]` type for one-or-none queries. It also provides Scala extension methods for the `Connection` type. -### solutions.bitbadger.documents.kotlinx - -![Maven Central Version](https://img.shields.io/maven-central/v/solutions.bitbadger.documents/kotlinx) +### kotlinx   [![Maven Central Version][kotlinx-badge]][kotlinx-mvn] This module utilizes [`kotlix.serialization`][kotlinx] for its serialization and deserialization, which implements these actions without reflection. As its primary consumer is Kotlin, it returns `null` for one-or-none queries. +## Read All about Them +- The "Docs" heading above will take you to the "Getting Started" page for these libraries, and is the entry point for all documentation (currently under active development). + +- The "Core API" heading links to the JavaDoc for the `core` module. Groovy consumers can also review the `Connection` extension functions there. + +- The "Scala API" heading links to the ScalaDoc for the `scala` module. + +- The "KotlinX API" heading links to the JavaDoc for the `kotlinx` module. + +## Talk about Them + +Bit Badger Solutions' Git is not set up for account registration _(yet! -- Homer Simpson)_. However, the author can be reached as `@Bit_Badger` on Twitter, `daniel@fedi.summershome.org` on the Fediverse, or via e-mail as `daniel` at the parent domain to this site's domain. This project is open to the public, so you will be able to track the progress of any issues you may report. + + +[core-badge]: https://img.shields.io/maven-central/v/solutions.bitbadger.documents/core +[core-mvn]: https://central.sonatype.com/artifact/solutions.bitbadger.documents/core +[groovy-badge]: https://img.shields.io/maven-central/v/solutions.bitbadger.documents/groovy +[groovy-mvn]: https://central.sonatype.com/artifact/solutions.bitbadger.documents/groovy +[scala-badge]: https://img.shields.io/maven-central/v/solutions.bitbadger.documents/scala +[scala-mvn]: https://central.sonatype.com/artifact/solutions.bitbadger.documents/scala +[kotlinx-badge]: https://img.shields.io/maven-central/v/solutions.bitbadger.documents/kotlinx +[kotlinx-mvn]: https://central.sonatype.com/artifact/solutions.bitbadger.documents/kotlinx [kotlinx]: https://github.com/Kotlin/kotlinx.serialization "KotlinX Serialization • GitHub" diff --git a/toc.yml b/toc.yml index 4159304..2a620f0 100644 --- a/toc.yml +++ b/toc.yml @@ -1,2 +1,8 @@ - name: Docs - href: docs/ \ No newline at end of file + href: docs/ +- name: Core API + href: core/ +- name: Scala API + href: scala/ +- name: KotlinX API + href: kotlinx/ \ No newline at end of file