Initialize README (#1)

This commit is contained in:
Jordan Jensen 2019-09-20 13:03:06 -07:00 committed by Gary Smith
parent 708c014058
commit ff107ca94a
1 changed files with 23 additions and 0 deletions

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# Octant Airship UI Plugin
A plugin built for use with [Octant](https://github.com/vmware/octant) to manage
declarative infrastructure using Airship.
## Prerequisites
- [Go 1.12+](https://golang.org/dl/)
## Getting Started
```
git clone https://opendev.org/airship/airshipui
cd airshipui
make
```
The default make target builds and installs the plugin to
`$HOME/.config/octant/plugin/`
The next time Octant is run it will include plugins in the above directory.
Further information for running Octant can be found in the
[Octant Repo](https://github.com/vmware/octant).