Skip to content
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

Improve README #271

Open
IndrajeetPatil opened this issue Sep 27, 2022 · 3 comments
Open

Improve README #271

IndrajeetPatil opened this issue Sep 27, 2022 · 3 comments
Assignees
Labels
Docs 📚 Improvements or additions to documentation

Comments

@IndrajeetPatil
Copy link
Member

IndrajeetPatil commented Sep 27, 2022

Instead of being a feature dump, it should describe the package goals.

When ready, including #87 will also improve things.

@etiennebacher
Copy link
Member

Maybe we could replace the list of examples with a two-column table showing data wrangling functions in one column and data transformation functions in the other one?

@IndrajeetPatil
Copy link
Member Author

I was actually thinking that maybe we could just copy-paste most of the content from our JOSS paper. It gives the high-level and overview and also points to a place where all available functionality can be found.

We did the same for see package README. WDYT?

@etiennebacher
Copy link
Member

Why not, but I think we can trim the JOSS paper and not copy paste it exactly in the readme. To take the example of see, I think the statement of need could be shortened to a few bullet points. I would prefer having a quick summary of the core use of the package and links to the paper and website. But this is just my preference

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 📚 Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants