Add install instructions to documentation

This commit is contained in:
David Bliss 2018-02-16 16:24:59 +00:00 committed by Mike Farah
parent 298126864f
commit e552dbb6ab
3 changed files with 197 additions and 173 deletions

View File

@ -4,9 +4,14 @@ a lightweight and portable command-line YAML processor
The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files.
## Install
On MacOS:
```
brew install yq
```
On Ubuntu and other Linux distros supporting `snap` packages:
```
snap install yq
```
or, [Download latest binary](https://github.com/mikefarah/yq/releases/latest) or alternatively:
```
go get github.com/mikefarah/yq

View File

@ -234,6 +234,13 @@
brew install yq
</a>
</li>
<li class="md-nav__item">
<a href="#snap-install-yq" title="snap install yq" class="md-nav__link">
snap install yq
</a>
</li>
<li class="md-nav__item">
@ -344,6 +351,13 @@
brew install yq
</a>
</li>
<li class="md-nav__item">
<a href="#snap-install-yq" title="snap install yq" class="md-nav__link">
snap install yq
</a>
</li>
<li class="md-nav__item">
@ -381,6 +395,7 @@
<p>yq is a lightweight and portable command-line YAML processor</p>
<p>The aim of the project is to be the <a href="https://github.com/stedolan/jq">jq</a> or sed of yaml files.</p>
<h3 id="brew-install-yq">brew install yq<a class="headerlink" href="#brew-install-yq" title="Permanent link">&para;</a></h3>
<h3 id="snap-install-yq">snap install yq<a class="headerlink" href="#snap-install-yq" title="Permanent link">&para;</a></h3>
<h3 id="download-latest-binary"><a href="https://github.com/mikefarah/yq/releases/latest">download latest binary</a><a class="headerlink" href="#download-latest-binary" title="Permanent link">&para;</a></h3>
<h3 id="get-the-source">get the source<a class="headerlink" href="#get-the-source" title="Permanent link">&para;</a></h3>
<pre><code class="bash">go get github.com/mikefarah/yq

View File

@ -4,13 +4,17 @@ yq is a lightweight and portable command-line YAML processor
The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files.
## Install
On MacOS:
```
brew install yq
```
On Ubuntu and other Linux distros supporting `snap` packages:
```
snap install yq
```
or, [Download latest binary](https://github.com/mikefarah/yq/releases/latest) or alternatively:
```
go get github.com/mikefarah/yq
```
[View on GitHub](https://github.com/mikefarah/yq)