Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 5.76 KB

README-template.md

File metadata and controls

109 lines (77 loc) · 5.76 KB
Raw

Project Name

Contributor Covenant License GitHub release

The section after the title is where we say what this library, sample, or SDK does in a few sentences. Consider adding:

  • Short description of use case + problem(s) solved. Consider the following:
    • Have you described what it is and what the benefits are in a way a non-developer can understand?
    • If someone Googles to try to learn more about it, is this description easy to find?
    • TL;DR? If someone looks at it for 6 seconds can they be convinced?
    • Do you compare your tool to other similar tools so people feel educated about pros/cons of yours?
    • If performance matters, do you have easy-to-skim benchmarks that include comparing it to other tools?
    • Do you have a demo? If it’s open source, are there well documented and easy to build samples/demos? Have you talked with developers who may be interested to learn about why they haven’t tried it or don’t use it?
  • Platform/language version supported
  • Links to the project in other repos (npm, packagist, etc)
  • Information about maintained and deprecated branches
  • Repo status - maintained, deprecated, etc.
  • Other resources:

Table of Contents

Make sure this is updated based on the sections included:

Documentation

This section should describe the documentation contained within this repo as well as links to other helpful pages. Full documentation for the library should not, ideally, be located in the repo README and must not be duplicated from somewhere else. If the README is being updated to adhere to these guidelines and the documentation only exists in the readme, consider moving it to a docs page or a Quickstart.

Consider adding:

  • How to generate documentation in the project (if applicable)
  • Links to Quickstarts and sample projects
  • Links to any specific .md files in the repo
  • Links to CloudZero Docs
  • Links to CloudZero Blog Posts
  • Links to any helpful supporting information about the project
  • Links to relevant Community posts (consider parsing and adding somewhere more easily accessible)

Installation

This section should outline what is required to install and configure this project. Consider adding:

  • Prerequisites for use
  • Command line instructions using bash syntax:
npm install
composer install
  • Links to information about package manager used
  • Information about .env values needed (include an example.env file)
  • Include different ways to install, indicate preferred method
  • Include instructions on how to install older versions

Getting Started

This section should include basic usage instructions that can be successfully completed after Installation above. This section should be a short introduction to how this library can be used, not a duplication of existing Quickstarts.

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

Support + Feedback

Include information on how to get support. Consider adding:

  • Use Github Issues for code-level support
  • Contact support@cloudzero.com for usage, questions, specific cases
  • Link to other support forums and FAQs

Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. Email security@cloudzero.com instead.

What is CloudZero?

CloudZero is the only cloud cost intelligence platform that puts engineering in control by connecting technical decisions to business results.:

  • Cost Allocation And Tagging Organize and allocate cloud spend in new ways, increase tagging coverage, or work on showback.
  • Kubernetes Cost Visibility Understand your Kubernetes spend alongside total spend across containerized and non-containerized environments.
  • FinOps And Financial Reporting Operationalize reporting on metrics such as cost per customer, COGS, gross margin. Forecast spend, reconcile invoices and easily investigate variance.
  • Engineering Accountability Foster a cost-conscious culture, where engineers understand spend, proactively consider cost, and get immediate feedback with fewer interruptions and faster and more efficient innovation.
  • Optimization And Reducing Waste Focus on immediately reducing spend by understanding where we have waste, inefficiencies, and discounting opportunities.

Learn more about CloudZero on our website www.cloudzero.com

License

This project is licenced under the Apache 2.0 LICENSE.