docs update

Author: aSemy

README.md

@@ -21,23 +21,30 @@ interface PlayerDetails {
 }
 ```
 
-The aim is to create TypeScript interfaces that can accurately produce JSON that Kotlinx
-Serialization can parse.
+The aim is to create TypeScript interfaces that can accurately produce Kotlinx Serialization
+compatible JSON.
+
+The Kotlinx Serialization API should be used to generate TypeScript. The
+[`SerialDescriptor`s](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.descriptors/-serial-descriptor/index.html)
+are flexible and comprehensive enough to allow for accurate TypeScript code, without any deviation.
 
 See [the docs](./docs) for working examples.
 
 ## Status
 
 This is a proof-of-concept.
 
-|                                       | Status                                                   | Notes                                                                                             |
-|---------------------------------------|----------------------------------------------------------|:--------------------------------------------------------------------------------------------------|
-| Basic classes                         | ✅       [example](./docs/basic-classes.md)               |                                                                                                   |
-| Nullable and default-value properties | ✅       [example](./docs/default-values.md)              |                                                                                                   |
-| Value classes                         | ✅       [example](./docs/value-classes.md)               |                                                                                                   |
-| Enums                                 | ✅       [example](./docs/enums.md)                       |                                                                                                   |
-| Lists                                 | ✅       [example](./docs/lists.md)                       |                                                                                                   |
-| Maps                                  | ✅/⚠     [example](./docs/maps.md)                        | Maps with complex keys are converted to an ES6 Map.  [See](./docs/maps.md#maps-with-complex-keys) |
-| Polymorphism - Sealed classes         | ✅/⚠     [example](./docs/polymorphism.md#sealed-classes) | Nested sealed classes are ignored                                                                 |
-| Polymorphism - Open classes           | ❌       [example](./docs/abstract-classes.md)            | Not implemented. Converted to `type MyClass = any`                                                |
-| Edge cases - circular dependencies    | ✅       [example](./docs/edgecases.md)                   |                                                                                                   |
+|                                       | Status                                                   | Notes                                                                                            |
+|---------------------------------------|----------------------------------------------------------|:-------------------------------------------------------------------------------------------------|
+| Kotlin multiplatform                  | ❓                                                        | The codebase is multiplatform, but only JVM has been tested                                      |
+| `@SerialName`                         | ✅/⚠                                                      | The serial name is directly converted and might produce invalid TypeScript                       |
+| Basic classes                         | ✅       [example](./docs/basic-classes.md)               |                                                                                                  |
+| Nullable and default-value properties | ✅       [example](./docs/default-values.md)              |                                                                                                  |
+| Value classes                         | ✅       [example](./docs/value-classes.md)               |                                                                                                  |
+| Enums                                 | ✅       [example](./docs/enums.md)                       |                                                                                                  |
+| Lists                                 | ✅       [example](./docs/lists.md)                       |                                                                                                  |
+| Maps                                  | ✅/⚠     [example](./docs/maps.md)                        | Maps with complex keys are converted to an ES6 Map, [see](./docs/maps.md#maps-with-complex-keys) |
+| Polymorphism - Sealed classes         | ✅/⚠     [example](./docs/polymorphism.md#sealed-classes) | Nested sealed classes are ignored, [see](./docs/polymorphism.md#nested-sealed-classes)           |
+| Polymorphism - Open classes           | ❌       [example](./docs/abstract-classes.md)            | Not implemented. Converted to `type MyClass = any`                                               |
+| `@JsonClassDiscriminator`             | ❌                                                        | Not implemented                                                                                  |
+| Edge cases - circular dependencies    | ✅       [example](./docs/edgecases.md)                   |                                                                                                  |

modules/kxs-ts-gen-processor/build.gradle.kts

@@ -7,6 +7,8 @@ plugins {
 //  id("org.jetbrains.reflekt")
 }
 
+description = "Experimental alternative to Kotlinx Serialization. Currently unused."
+
 val kspVersion = "1.6.10-1.0.4"
 val kotlinCompileTestingVersion = "1.4.7"
 val kotlinxSerializationVersion = "1.3.2" // TODO put dependencies in libs.version.toml