Skip to content

Commit

Permalink
docs: updated README.md
Browse files Browse the repository at this point in the history
Signed-off-by: roee88 <roee88@gmail.com>
  • Loading branch information
roee88 committed Jan 10, 2021
1 parent a2a5a77 commit c94bd53
Showing 1 changed file with 2 additions and 13 deletions.
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,17 @@ Generate markdown documentation from Kubernetes `CustomResourceDefinition` YAML

## Install

Use one of the following methods to install `crdoc`.
Download the appropriate version for your platform from [Releases](https://github.com/mesh-for-data/crdoc/releases/latest). You may want to install the binary to somewhere in your system's PATH such as `/usr/local/bin`.

### Binary (Cross-platform)

Download the appropriate version for your platform from [Releases](https://github.com/mesh-for-data/crdoc/releases/latest).
You may want to install it somewhere in your system's PATH such as `/usr/local/bin`.

### Using go get

If you have go 1.13 or later then you can run:
Alternatively, if you have go 1.13 or later then you can also use `go get`. This will put `crdoc` in `$(go env GOPATH)/bin`:

```bash
go get github.com/mesh-for-data/crdoc
```

This will put `crdoc` in `$(go env GOPATH)/bin`. You may need to add that directory to your system's PATH if you encounter a "command not found" error.

## Usage

```
Output markdown documentation from Kubernetes CustomResourceDefinition YAML files
Usage:
crdoc [flags]
Expand Down

0 comments on commit c94bd53

Please sign in to comment.