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

Docs/Readme improvements #102

Closed
dlorenc opened this issue May 25, 2021 · 4 comments
Closed

Docs/Readme improvements #102

dlorenc opened this issue May 25, 2021 · 4 comments

Comments

@dlorenc
Copy link
Contributor

dlorenc commented May 25, 2021

We should reorganize the readme a bit to make this more approachable. Some ideas:

  • Start with the description of what chains is for, and then a quick list of all the features
  • Then show installation and a quickstart
  • Move exhaustive config documentation to it's own page
  • Move tutorials for each key/signing type to their own page
  • A fancy gif/screenshot never hurts!
@priyawadhwa
Copy link
Contributor

A logo would be cool too 😄

@dlorenc
Copy link
Contributor Author

dlorenc commented May 25, 2021

https://github.com/cdfoundation/artwork/blob/main/tekton/additional-artwork/tekton-chains/color/tekton_chains-color.svg

@dlorenc
Copy link
Contributor Author

dlorenc commented May 25, 2021

I keep forgetting to move them here :)

@priyawadhwa
Copy link
Contributor

ooh amazing!

@priyawadhwa priyawadhwa mentioned this issue May 25, 2021
Merged
@priyawadhwa priyawadhwa mentioned this issue Jun 7, 2021
Closed
5 tasks
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
2 participants
@dlorenc @priyawadhwa