Skip to content

Commit c54fcd5

Browse files
committed
added README.md for json module
1 parent c5821dd commit c54fcd5

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

dataframe-json/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## :dataframe-json
2+
3+
This module, published as `dataframe-json`, contains all logic and tests for DataFrame to be able to work with
4+
JSON data sources; [reading](https://kotlin.github.io/dataframe/read.html#read-from-json)
5+
and [writing](https://kotlin.github.io/dataframe/write.html#writing-to-json).
6+
It's based on [Kotlinx Serialization](https://github.com/Kotlin/kotlinx.serialization).
7+
8+
It also contains some logic specific to encoding dataframes as JSON objects with metadata for
9+
the [custom table component in Kotlin Notebook](https://kotlin.github.io/dataframe/usage-with-kotlin-notebook-plugin.html).
10+
See [serialization_format](../docs/serialization_format.md) for more information about the format.
11+
12+
This module is optional but is included by default by the `dataframe` module, `dataframe-jupyter`,
13+
`dataframe-csv`, and `dataframe-excel`.
14+
If you want to use DataFrame without JSON support, you can exclude this module from the dependency.

0 commit comments

Comments
 (0)