Skip to content

Readme update #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 16, 2025
Merged

Readme update #1251

merged 3 commits into from
Jun 16, 2025

Conversation

AndreiKingsley
Copy link
Collaborator

@AndreiKingsley AndreiKingsley commented Jun 12, 2025

New additions and a lot of updates to main README.

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).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"or other interactive environment with Kotlin Jupyter Kernel support, such as DataLore and Kotlin Jupyter"?

odd sentence

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.

![quickstart_preview](docs/StardustDocs/images/guides/quickstart_preview.png)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you make the picture clickable? so it takes you to the quickstart guide as well?

@@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe put this at the bottom?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. It's a general recommendation for both KTNB and gradle.
  2. I'd like user to use website setup guidelines, here it is not detailed enough.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, but it looks a bit weird to have two headers with just a note in between them

README.md Outdated

// Update the DataFrame.
val reposUpdated = repos
// Rename columns to CamelCase.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a lot of spaces

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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

visualizations or visualisations? ;P you write it in two ways

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we follow american english, it should be a z

Copy link
Collaborator

@Jolanrensen Jolanrensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it :) just some minor comments

@AndreiKingsley AndreiKingsley merged commit c0603bb into master Jun 16, 2025
5 checks passed
@AndreiKingsley AndreiKingsley deleted the readme_update branch June 16, 2025 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider another example for readme page
2 participants