Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.85 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.85 KB

REUSE status

modulectl

Overview

modulectl is a command line tool which supports Kyma Module developers. It provides a set of commands and flags you can use to:

  • Create an emtpy scaffold for a new module
  • Build a module and push it to a remote repository

Prerequisites

List the requirements to run the project or example.

Installation

Explain the steps to install your project. If there are multiple installation options, mention the recommended one and include others in a separate document. Create an ordered list for each installation task.

If it is an example README.md, describe how to build, run locally, and deploy the example. Format the example as code blocks and specify the language, highlighting where possible. Explain how you can validate that the example ran successfully. For example, define the expected output or commands to run which check a successful deployment.

Add subsections (H3) for better readability.

Usage

Explain how to use the project. You can create multiple subsections (H3). Include the instructions or provide links to the related documentation.

Development

Add instructions on how to develop the project or example. It must be clear what to do and, for example, how to trigger the tests so that other contributors know how to make their pull requests acceptable. Include the instructions or provide links to related documentation.

Contributing

See the Contributing Rules.

Code of Conduct

See the Code of Conduct document.

Licensing

See the license file.