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

Update the README #324

Merged
merged 7 commits into from
Nov 11, 2022
Merged

Update the README #324

merged 7 commits into from
Nov 11, 2022

Conversation

courtneycl
Copy link
Collaborator

@courtneycl courtneycl commented Nov 11, 2022

This PR reorganises the readme in hopes it is a bit more legible and easier to scan. It also updates the examples to v3.

@courtneycl courtneycl requested a review from a team as a code owner November 11, 2022 00:52
Comment on lines +136 to +138
- 'GPL-3.0'
- 'BSD-3-Clause'
- 'MIT'
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is having quotes right here? In the current README the individual YAML examples don't have quotes 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quotes in YAML are optional, can be taken out if needed!

@courtneycl courtneycl requested a review from febuiles November 11, 2022 00:59
@febuiles febuiles merged commit 235a221 into main Nov 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants