Update README and examples #8
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit refactors the README to add a little more documentation on how to use the function. It also tries to match the README style of the other composition functions. I've also broken the examples out into two directories. The Inline example can be rendered using the Crossplane CLI. I've simplified that one a bit to streamline doing that. The FileSystem example can't, so I've left it as it was. Signed-off-by: Nic Cope <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
This PR refactors the README to add a little more documentation on how to use the function. It also tries to match the README style of the other composition functions.
I've also broken the examples out into two directories. The Inline example can be rendered using the Crossplane CLI. I've simplified that one a bit to streamline doing that. The FileSystem example can't, so I've left it as it was.
I have: