From e552dbb6ab8561d59ad0a17145bab975a26792b7 Mon Sep 17 00:00:00 2001 From: David Bliss Date: Fri, 16 Feb 2018 16:24:59 +0000 Subject: [PATCH] Add install instructions to documentation --- README.md | 5 + docs/index.html | 359 +++++++++++++++++++++++++----------------------- mkdocs/index.md | 6 +- 3 files changed, 197 insertions(+), 173 deletions(-) diff --git a/README.md b/README.md index 204ddd17..6e693b9e 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/index.html b/docs/index.html index 03ceca49..a37b987e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,76 +5,76 @@ - + - - - - + + + + - + - + - + - + - + - + - + - - - + + + Yq - - - + + + - - - + + + - - - + + + - + - - - + + + - + - + - - + + - + - +
- +
- - - - + + + +
- - + +
- - + +
- +
- - + +
- - + + - - + +

yq

yq is a lightweight and portable command-line YAML processor

The aim of the project is to be the jq or sed of yaml files.

brew install yq

+

snap install yq

download latest binary

get the source

go get github.com/mikefarah/yq
@@ -388,25 +403,25 @@
 
 
.zip or tar.gz

 
View on GitHub

-                
-                  
-                
-              
-              
-                
-              
+
+
+
+
+
+
+
- - + + - +
- + - + - - - - - + + + + + - \ No newline at end of file + diff --git a/mkdocs/index.md b/mkdocs/index.md index ba4273cf..e4beb998 100644 --- a/mkdocs/index.md +++ b/mkdocs/index.md @@ -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) -