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

README improvements #301

Open
joao-m-santos opened this issue Sep 13, 2023 · 1 comment
Open

README improvements #301

joao-m-santos opened this issue Sep 13, 2023 · 1 comment
Assignees
Labels
documentation improvements or additions to documentation

Comments

@joao-m-santos
Copy link
Contributor

joao-m-santos commented Sep 13, 2023

Some possible improvements for the README.md:

  • Use Cases: Might be good to briefly mention some specific problems Lume can solve or scenarios where it can be beneficial to use Lume.
  • Quick Example: While you have information about how to install and import Lume, a quick code example to demonstrate the simplest use-case would help users quickly understand its utility - maybe a reference to using the alluvial? Screenshots/GIFs could be more effective than text here in general given it's a data visualization library.
  • Features: List the features that make Lume stand out, or any features you plan to add in the future, to give users an idea of why they might choose it over other similar libraries.
  • FAQs: You might want to include a Frequently Asked Questions section to anticipate and resolve common issues that users might face.

Thanks @jrodriguez5909 for the pointers

@joao-m-santos joao-m-santos added the documentation improvements or additions to documentation label Sep 13, 2023
@joao-m-santos joao-m-santos self-assigned this Sep 13, 2023
@jrodriguez5909
Copy link

Yessir! @joao-m-santos

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

No branches or pull requests

2 participants