Skip to content

Commit 32abe33

Browse files
committed
spruce up README
1 parent 03033e9 commit 32abe33

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
[![GitHub license](https://img.shields.io/github/license/adamko-dev/kotlinx-serialization-typescript-generator?style=flat-square)](https://github.com/adamko-dev/kotlinx-serialization-typescript-generator/blob/main/LICENSE)
2-
[![Maven Central](https://img.shields.io/maven-central/v/dev.adamko.kxstsgen/kxs-ts-gen-core?color=%234c1&style=flat-square)](https://search.maven.org/search?q=g:dev.adamko.kxstsgen)
3-
[![Jitpack.io](https://jitpack.io/v/adamko-dev/kotlinx-serialization-typescript-generator.svg?style=flat-square)](https://jitpack.io/#adamko-dev/kotlinx-serialization-typescript-generator)
1+
[![GitHub license](https://img.shields.io/github/license/adamko-dev/kotlinx-serialization-typescript-generator?style=for-the-badge)](https://github.com/adamko-dev/kxstsgen/blob/main/LICENSE)
2+
[![Maven Central](https://img.shields.io/maven-central/v/dev.adamko.kxstsgen/kxs-ts-gen-core?style=for-the-badge&logo=apache-maven&color=6545e7&link=https%3A%2F%2Fsearch.maven.org%2Fsearch%3Fq%3Dg%3Adev.adamko.kxstsgen)](https://search.maven.org/search?q=g:dev.adamko.kxstsgen)
3+
[![Maven metadata URL](https://img.shields.io/maven-metadata/v?label=MAVEN%20SNAPSHOT&metadataUrl=https%3A%2F%2Fs01.oss.sonatype.org%2Fcontent%2Frepositories%2Fsnapshots%2Fdev%2Fadamko%2Fkxstsgen%2Fkxs-ts-gen-core%2Fmaven-metadata.xml&style=for-the-badge&logo=apache-maven)](https://s01.oss.sonatype.org/content/repositories/snapshots/dev/adamko/kxstsgen/kxs-ts-gen-core/)
44

55
# Kotlinx Serialization TypeScript Generator
66

77
[Kotlinx Serialization TypeScript Generator](https://github.com/adamko-dev/kotlinx-serialization-typescript-generator)
8-
creates TypeScript interfaces from
8+
(or **kxs-ts-gen** for short) creates TypeScript interfaces from
99
[Kotlinx Serialization](https://github.com/Kotlin/kotlinx.serialization/)
10-
classes.
10+
classes, allowing for quick and easy communication via JSON with a Kotlin-first approach.
1111

1212
```kotlin
13+
import kotlinx.serialization.*
14+
import dev.adamko.kxstsgen.*
15+
1316
@Serializable
1417
class MyClass(
1518
val aString: String,
@@ -39,17 +42,16 @@ export interface MyClass {
3942

4043
Only Kotlinx Serialization
4144
[`SerialDescriptor`s](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.descriptors/-serial-descriptor/index.html)
42-
are used to generate TypeScript. They are flexible and comprehensive enough to allow for accurate TypeScript code, without any deviation.
45+
are used to generate TypeScript.
46+
They are flexible and comprehensive enough to allow for accurate TypeScript code, without any
47+
surprises.
4348

44-
See [the docs](./docs) for working examples.
49+
See
50+
[the docs](https://adamko-dev.github.io/kotlinx-serialization-typescript-generator/)
51+
for working examples.
4552

4653
## Status
4754

48-
This is a proof-of-concept.
49-
50-
The aim is to create TypeScript interfaces that can accurately produce Kotlinx Serialization
51-
compatible JSON.
52-
5355
| | Status | Notes |
5456
|---------------------------------------|-----------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------|
5557
| Kotlin multiplatform || The codebase is multiplatform, but only JVM has been tested |

0 commit comments

Comments
 (0)