Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.75 KB

README.md

File metadata and controls

34 lines (21 loc) · 1.75 KB

Marker Logo

Markers

Go Report Card CircleCI codecov

Marker project aims to make markers available for everyone.

It is inspired by Kubernetes Markers, which help avoid boilerplate code and simplify code logic while working on kubernetes operators. And also it includes some code snippets from controller-tools.

Markers are single-comments that start with a plus, followed by a marker name, optionally followed some marker parameters, which are used to generate or verify code but add no logic at runtime.

Installation

To Install Marker CLI quickly, follow the installation instructions.

  1. You first need Go installed (version 1.18+ is required), then you can use the below Go command to install Marker CLI.

    $ go get -u github.com/procyon-projects/marker/...

  2. Verify that you've installed Marker CLI by typing the following command.

    $ marker version

  3. Confirm that the command prints the installed version of Marker CLI.

Type the following command to display usage information for the Marker CLI.

$ marker help

License

Marker is released under Apache-2.0 License.