Update module docs with artifacts, fix names

Signed-off-by: Ryan Nett <JNett96@gmail.com>
rnett · Jun 2, 2021 · 5184774 · 5184774
1 parent cec436a
commit 5184774
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 7 deletions.
diff --git a/core/krosstalk-base/README.md b/core/krosstalk-base/README.md
@@ -1,8 +1,10 @@
-# Module Krosstalk Core
+# Module Krosstalk Base
 
 Krosstalk APIs that are shared between the runtime and compiler plugin. None of these are user facing, you should not
 need them unless you are implementing a plugin.
 
+Artifact: `com.github.rnett.krosstalk:krosstalk-base` (you shouldn't ever need this)
+
 # Package com.rnett.krosstalk
 
 Contains the default values for annotations, and the special parameter keys for endpoints (i.e. [extensionReceiver]).

diff --git a/core/krosstalk-client/README.md b/core/krosstalk-client/README.md
@@ -2,6 +2,8 @@
 
 Krosstalk APIs necessary for defining a client.
 
+Artifact: `com.github.rnett.krosstalk:krosstalk-client`
+
 For usage instructions, see the [github readme](./../../README.md#krosstalk-a-pure-kotlin-pluggable-rpc-library).
 
 For more examples, see [tests](./../../tests).

diff --git a/core/krosstalk-server/README.md b/core/krosstalk-server/README.md
@@ -2,6 +2,8 @@
 
 Krosstalk APIs necessary for defining a server.
 
+Artifact: `com.github.rnett.krosstalk:krosstalk-server`
+
 For usage instructions, see the [github readme](./../../README.md#krosstalk-a-pure-kotlin-pluggable-rpc-library).
 
 For more examples, see [tests](./../../tests).

diff --git a/core/krosstalk/README.md b/core/krosstalk/README.md
@@ -1,8 +1,10 @@
-# Module Krosstalk
+# Module Krosstalk Core
 
 Common Krosstalk APIs that are used be both clients and servers, and everything required to define an `expect`
 Krosstalk. Includes `Krosstalk`, `Scope`, `KrosstalkResult`, etc.
 
+Artifact: `com.github.rnett.krosstalk:krosstalk`
+
 Usually the only source set that needs to explicitly depend on this artifact is the `common` one, source sets or modules
 with Krosstalk client or servers will inherit it.
 

diff --git a/plugins/README.md b/plugins/README.md
@@ -1,4 +1,24 @@
-# Ktor
+# Plugins
 
-This directory contains basic Ktor client and server plugins. Both include authentication scopes, and the client plugin
-is multiplatform.
+We provide plugins for [Kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization) 
+and [Ktor](https://ktor.io/) client and server.  Authentication scopes for Ktor clients and servers are also included.
+
+If you are making a third party plugin, please make an issue or PR on the 
+[GitHub repo](https://github.com/rnett/krosstalk) so that we can list it here.
+
+## Artifacts
+
+#### Serialization
+
+* Kotlinx serialization (includes JSON): `com.github.rnett.krosstalk:krosstalk-kotlinx-serialization`
+
+#### Client
+
+* Ktor: `com.github.rnett.krosstalk:krosstalk-ktor-client`
+    * Auth: `krosstalk-ktor-client-auth`
+
+#### Server
+
+* Ktor: `com.github.rnett.krosstalk:krosstalk-ktor-server`
+    * Auth: `krosstalk-ktor-server-auth`
+        * JWT: `krosstalk-ktor-server-auth-jwt`
diff --git a/plugins/krosstalk-kotlinx-serialization/README.md b/plugins/krosstalk-kotlinx-serialization/README.md
@@ -2,6 +2,8 @@
 
 A Krosstalk serialization plugin using [Kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization).
 
+Artifact: `com.github.rnett.krosstalk:krosstalk-kotlinx-serialization`
+
 Provides the JSON format by default, others can be used as well.
 
 [KotlinxBinarySerializationHandler] is used for binary formats, and [KotlinxStringSerializationHandler] for string

diff --git a/plugins/ktor-client/krosstalk-ktor-client-auth/README.md b/plugins/ktor-client/krosstalk-ktor-client-auth/README.md
@@ -2,6 +2,8 @@
 
 Auth scopes for the Krosstalk Ktor client plugin.
 
+Artifact: `com.github.rnett.krosstalk:krosstalk-ktor-client-auth`
+
 [KtorClientAuth] can be used to configure a generic Ktor auth feature.
 
 [KtorClientBasicAuth] configures basic auth.

diff --git a/plugins/ktor-client/krosstalk-ktor-client/README.md b/plugins/ktor-client/krosstalk-ktor-client/README.md
@@ -1,6 +1,9 @@
 # Module Krosstalk Ktor Client
 
-A basic multiplatform Krosstalk client plugin using [Ktor](https://ktor.io/).
+A basic multiplatform Krosstalk client plugin using [Ktor](https://ktor.io/).  Supports all platforms Ktor does,
+which is currently everything except `watchosX64`.
+
+Artifact: `com.github.rnett.krosstalk:krosstalk-ktor-client`
 
 To use, have your Krosstalk client object implement `KtorKrosstalkClient`, and set `client` to a `KtorClient`.
 

diff --git a/plugins/ktor-server/krosstalk-ktor-server-auth-jwt/README.md b/plugins/ktor-server/krosstalk-ktor-server-auth-jwt/README.md
@@ -2,6 +2,8 @@
 
 A Jwt Auth scope for the Krosstalk Ktor server plugin.
 
+Artifact: `com.github.rnett.krosstalk:krosstalk-ktor-server-auth-jwt`
+
 # Package com.rnett.krosstalk.ktor.server.auth
 
 A Jwt Auth scope for the Krosstalk Ktor server plugin. See module description.
diff --git a/plugins/ktor-server/krosstalk-ktor-server-auth/README.md b/plugins/ktor-server/krosstalk-ktor-server-auth/README.md
@@ -2,6 +2,8 @@
 
 Auth scopes for the Krosstalk Ktor server plugin.
 
+Artifact: `com.github.rnett.krosstalk:krosstalk-ktor-server-auth`
+
 We provide a base auth scope [KtorServerAuth], a base auth scope for authentication types that provide a
 principal [KtorServerPrincipalAuth], and several implementations:
 

diff --git a/plugins/ktor-server/krosstalk-ktor-server/README.md b/plugins/ktor-server/krosstalk-ktor-server/README.md
@@ -1,6 +1,9 @@
 # Module Krosstalk Ktor Server
 
-A basic Krosstalk server plugin using [Ktor](https://ktor.io/). Includes authentication scopes.
+A basic Krosstalk server plugin using [Ktor](https://ktor.io/). Includes authentication scopes.  Note that like Ktor itself,
+this only supports JVM.  Clients, however, are multiplatform.
+
+Artifact: `com.github.rnett.krosstalk:krosstalk-ktor-server`
 
 To use, have your Krosstalk server object implement `KtorKrosstalkServer`, and set `server` to a `KtorServer`.