Readme update #1251
Open
Readme update #1251
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jolanrensen
reviewed
Jun 12, 2025
README.md
Outdated
| You can use Kotlin DataFrame in [Kotlin Notebook](https://plugins.jetbrains.com/plugin/16340-kotlin-notebook), | ||
| or other interactive environment with Kotlin Jupyter Kernel support, such as | ||
| [Datalore](https://datalore.jetbrains.com/), | ||
| and [Kotlin Jupyter](https://github.com/Kotlin/kotlin-jupyter). |
There was a problem hiding this comment.
"or other interactive environment with Kotlin Jupyter Kernel support, such as DataLore and Kotlin Jupyter"?
odd sentence
Jolanrensen
reviewed
Jun 12, 2025
README.md
Outdated
| It walks you through the core features of Kotlin DataFrame with minimal setup and clear examples | ||
| — perfect for getting up to speed in just a few minutes. | ||
|
|
||
|  |
There was a problem hiding this comment.
can you make the picture clickable? so it takes you to the quickstart guide as well?
Jolanrensen
reviewed
Jun 12, 2025
| @@ -46,31 +57,102 @@ Check out this [notebook with new features](examples/notebooks/feature_overviews | |||
|
|
|||
| ## Setup | |||
|
|
|||
| ```kotlin | |||
| implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta2") | |||
| > For more detailed instructions on how to get started with Kotlin DataFrame, refer to the | |||
There was a problem hiding this comment.
maybe put this at the bottom?
There was a problem hiding this comment.
- It's a general recommendation for both KTNB and gradle.
- I'd like user to use website setup guidelines, here it is not detailed enough.
Jolanrensen
reviewed
Jun 12, 2025
README.md
Outdated
|
|
||
| // Update the DataFrame. | ||
| val reposUpdated = repos | ||
| // Rename columns to CamelCase. |
Jolanrensen
reviewed
Jun 12, 2025
| Explore [**more examples here**](https://kotlin.github.io/dataframe/guides-and-examples.html). | ||
| ## Visualisations | ||
|
|
||
| [Kandy](https://kotlin.github.io/kandy/welcome.html) plotting library provides seamless visualizations |
There was a problem hiding this comment.
visualizations or visualisations? ;P you write it in two ways
There was a problem hiding this comment.
if we follow american english, it should be a z
Jolanrensen
approved these changes
Jun 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New additions and a lot of updates to main README.