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.

Sign up for GitHub

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

Jump to bottom

Improve the readability and this repo's README #443

Open
1 of 3 tasks
johnnymatthews opened this issue Dec 18, 2024 · 0 comments
Open
1 of 3 tasks

Improve the readability and this repo's README #443

johnnymatthews opened this issue Dec 18, 2024 · 0 comments
Assignees
@johnnymatthews
Labels
documentation Improvements or additions to documentation

Comments

@johnnymatthews
Copy link
Contributor

Title: Improve the readability and this repo's README

Issue type: (Select one)

  • Bug
  • Question
  • Improvement

Description:

The README of this repo is pretty long, overwhelming, and contains information that would be better suited for a deep-docs-dive in places like docs.entropy.xyz. Let's simplify the README by sticking to the following sections:

  • Quick overview (what this SDK is for, who it's for, some example use-cases)
  • Installation instructions
  • Basic usage example
  • Links to detailed docs over at docs.entropy.xyz
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnnymatthews johnnymatthews

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@johnnymatthews