diff --git a/README.md b/README.md index 376ad17..54b4e8a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ -# Codeowners Validator -[![Go Report Card](https://goreportcard.com/badge/github.com/mszostok/codeowners-validator)](https://goreportcard.com/report/github.com/mszostok/codeowners-validator) [![Build Status](https://travis-ci.com/mszostok/codeowners-validator.svg?branch=master)](https://travis-ci.com/mszostok/codeowners-validator) +

+

GitHub CODEOWNERS Validator

+

Ensures the correctness of your CODEOWNERS file.

+

+ Software License + Go Report Card + Travis + +

+

-[![forthebadge](https://forthebadge.com/images/badges/made-with-go.svg)](https://forthebadge.com) +--- -## Overview - -The Codeowners Validator project validates the GitHub [CODEOWNERS](https://help.github.com/articles/about-code-owners/) file. It supports private GitHub repositories and GitHub Enterprise installations. +The Codeowners Validator project validates the GitHub [CODEOWNERS](https://help.github.com/articles/about-code-owners/) file using [those checks](#checks). It supports public and private GitHub repositories and also GitHub Enterprise installations. ![usage](./docs/assets/usage.png) @@ -19,10 +25,10 @@ Here is the recommended way to install `codeowners-validator`: ```bash # binary installed into ./bin/ -curl -sfL https://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh| sh -s v0.1.1 +curl -sfL https://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh| sh -s v0.2.0 # binary installed into $(go env GOPATH)/bin/codeowners-validator -curl -sfL https://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh| sh -s -- -b $(go env GOPATH)/bin v0.1.1 +curl -sfL https://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh| sh -s -- -b $(go env GOPATH)/bin v0.2.0 # In alpine linux (as it does not come with curl by default) wget -O - -q https://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh| sh -s v0.2.0 @@ -91,6 +97,6 @@ Application exits with different status codes which allow you to easily distingu ## Roadmap -The [codeowners-validator roadmap uses Github milestones](https://github.com/mszostok/codeowners-validator/milestones) to track the progress of the project. +The [codeowners-validator roadmap uses Github milestones](https://github.com/mszostok/codeowners-validator/milestone/1) to track the progress of the project. -Issues with the `priority/important-longterm` label will be implemented as the first one. +They are sorted with priority. First are most important.