The is a README template for CNCF projects. Please start by renaming this to README.md and deleting everything up to and including the "template begins here" comment in this markdown file.
This is a template document for CNCF projects that requires editing
before it is ready to use. Read the markdown comments, <!-- COMMENT -->, for
additional guidance. The raw markdown uses TODO to identify areas that
require customization. Replace [TODO: PROJECTNAME] with the name of your project.
Cloud Native Compositions is a [TODO: Type of Tool] that [TODO: Functions it performs]. [TODO: Reasons why these are needed and valuable]. [TODO: Implementation, strategy and architecture].
[TODO: Additional paragraph describing your project (optional)]
Our project welcomes contributions from any member of our community. To get started contributing, please see our [Contributor Guide](TODO: Link to CONTRIBUTING.md).
Cloud Native Compositions is intended to [TODO: Core functionality]. As such, the project will implement or has implemented:
- [TODO: High-level Item 1]
- [TODO: High-level Item 2]
- [TODO: High-level Item 3]
Cloud Native Compositions will be used in a cloud native environment with other tools. The following specific functionality will therefore not be incorporated:
- [TODO: Excluded function 1]
- [TODO: Excluded function 2]
Cloud Native Compositions implements [TODO: List of major features, existing or planned], through [TODO: Implementation requirements/language/architecture/etc.]. It will not cover [TODO: short list of excluded items]
[TODO: Details (with links) to meetings, mailing lists, Slack, and any other communication channels]
- User Mailing List:
- Developer Mailing List:
- Slack Channel:
- Public Meeting Schedule and Links:
- Social Media:
- Other Channel(s), If Any:
[TODO: Add links to other helpful information (roadmap, docs, website, etc.)]
This project is licensed under the Apache License 2.0
We follow the CNCF Code of Conduct.