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 readme #252

Open
sergiimk opened this issue Jan 14, 2024 · 0 comments
Open

Improve the readme #252

sergiimk opened this issue Jan 14, 2024 · 0 comments

Comments

@sergiimk
Copy link
Member

Our README could use an updated.

Let's use kamu-cli's documentation as an example and:

  • In README.md
    • only explain what the repo is about
    • mention how it can already be run as part of the CLI tool
  • Move all developer documentation into DEVELOPER.md and improve it using kamu-cli's developer docs as a model
    • Make sure to better explain all Auth options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sergiimk