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

Make README clear and understandable #13

Open
cardil opened this issue Apr 13, 2023 · 0 comments
Open

Make README clear and understandable #13

cardil opened this issue Apr 13, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers kind/enhancement New feature or request

Comments

@cardil
Copy link
Member

cardil commented Apr 13, 2023

The current README is fairly rudimentary, as clearly evidenced by the number of questions and discussions raised in #11.

The README should be clear, and verbose enough, understandable both for contributors and for end-users. I think it should contain the explanations on how to use the showcase app to demo Knative as well.

We should point out the features of this app, and how they map to the features of Knative.
@cardil cardil added documentation Improvements or additions to documentation good first issue Good for newcomers kind/enhancement New feature or request labels Apr 13, 2023
@cardil cardil mentioned this issue Apr 13, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers kind/enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cardil