Skip to content

Commit e357cd8

Browse files
authored
Update README.md
1 parent d5a1ef6 commit e357cd8

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

README.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,26 +35,19 @@ export interface MyClass {
3535
}
3636
```
3737

38-
The aim is to create TypeScript interfaces that can accurately produce Kotlinx Serialization
39-
compatible JSON.
40-
41-
The Kotlinx Serialization API should be used to generate TypeScript. The
38+
Only Kotlinx Serialization
4239
[`SerialDescriptor`s](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.descriptors/-serial-descriptor/index.html)
43-
are flexible and comprehensive enough to allow for accurate TypeScript code, without any deviation.
44-
45-
The aim is to create TypeScript interfaces that can accurately produce Kotlinx Serialization
46-
compatible JSON.
47-
48-
The Kotlinx Serialization API should be used to generate TypeScript. The
49-
[`SerialDescriptor`s](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.descriptors/-serial-descriptor/index.html)
50-
are flexible and comprehensive enough to allow for accurate TypeScript code, without any deviation.
40+
are used to generate TypeScript. They are flexible and comprehensive enough to allow for accurate TypeScript code, without any deviation.
5141

5242
See [the docs](./docs) for working examples.
5343

5444
## Status
5545

5646
This is a proof-of-concept.
5747

48+
The aim is to create TypeScript interfaces that can accurately produce Kotlinx Serialization
49+
compatible JSON.
50+
5851
| | Status | Notes |
5952
|---------------------------------------|-----------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------|
6053
| Kotlin multiplatform || The codebase is multiplatform, but only JVM has been tested |

0 commit comments

Comments
 (0)