docs README: Update installation instructions
This commit is contained in:
		
							parent
							
								
									de4171da31
								
							
						
					
					
						commit
						9923b1e64d
					
				
					 1 changed files with 24 additions and 3 deletions
				
			
		
							
								
								
									
										27
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										27
									
								
								README.md
									
										
									
									
									
								
							| 
						 | 
					@ -72,13 +72,33 @@ to only update the `api` resource sets and the `frontend/user-page` resource set
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Installation
 | 
					## Installation
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Assuming you have Go configured correctly, you can simply `go get github.com/tazjin/kontemplate/...`.
 | 
					It is recommended to install Kontemplate from the signed binary releases available on the
 | 
				
			||||||
 | 
					[releases page][]. Release binaries are available for Linux, OS X, FreeBSD and Windows.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
There are signed binary releases available on the [releases page][] for Linux, OS X,
 | 
					### Homebrew
 | 
				
			||||||
FreeBSD and Windows.
 | 
					
 | 
				
			||||||
 | 
					OS X users with Homebrew installed can "tap" Kontemplate like such:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```sh
 | 
				
			||||||
 | 
					brew tap tazjin/kontemplate https://github.com/tazjin/kontemplate
 | 
				
			||||||
 | 
					brew install kontemplate
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Arch Linux
 | 
				
			||||||
 | 
					
 | 
				
			||||||
An [AUR package][] is available for Arch Linux and other `pacman`-based distributions.
 | 
					An [AUR package][] is available for Arch Linux and other `pacman`-based distributions.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Building repeatably from source
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Version pinning for Go dependencies is provided by a [Repeatr][] formula. After cloning
 | 
				
			||||||
 | 
					the repository the latest release can be built with `repeatr run kontemplate.frm`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This will place release binaries in the `release` folder.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Building from source
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Assuming you have Go configured correctly, you can simply `go get github.com/tazjin/kontemplate/...`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Usage
 | 
					## Usage
 | 
				
			||||||
 | 
					
 | 
				
			||||||
You must have `kubectl` installed to use Kontemplate effectively.
 | 
					You must have `kubectl` installed to use Kontemplate effectively.
 | 
				
			||||||
| 
						 | 
					@ -130,3 +150,4 @@ kontemplate apply example/prod-cluster.yaml
 | 
				
			||||||
[Helm]: https://helm.sh/
 | 
					[Helm]: https://helm.sh/
 | 
				
			||||||
[releases page]: https://github.com/tazjin/kontemplate/releases
 | 
					[releases page]: https://github.com/tazjin/kontemplate/releases
 | 
				
			||||||
[AUR package]: https://aur.archlinux.org/packages/kontemplate-git/
 | 
					[AUR package]: https://aur.archlinux.org/packages/kontemplate-git/
 | 
				
			||||||
 | 
					[Repeatr]: http://repeatr.io/
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue