Mirrored_Repos/psu
1
0
Fork 0
mirror of https://gitlab.com/psuapp/psu.git synced 2024-08-30 18:12:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add mission and vision sections to Readme

Browse Source
This commit is contained in:
Juan Carlos Mejías Rodríguez 2019-09-01 18:52:14 -04:00
parent 9fc71f808a
commit d06d1dd3f0
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -9,6 +9,8 @@
## Table of contents
- [Overview](#overview)
- [Mission](#mission)
- [Vision](#vision)
- [Supported Portainer API](#supported-portainer-api)
- [How to install](#how-to-install)
- [How to use](#how-to-use)
@ -31,6 +33,18 @@ Portainer Stack Utils is a CLI client for [Portainer](https://portainer.io/) wri
**Attention:** The `master` branch contains the next major version, still unstable and under heavy development. A more stable (and also older) version is available as a Bash script in [release 0.1.1](https://github.com/greenled/portainer-stack-utils/releases/0.1.1), and also as a [Docker image](https://hub.docker.com/r/greenled/portainer-stack-utils). There is ongoing work in `1-0-next` branch to enhace that Bash version.
### Mission
To provide an **easy** and **extensible** way of interacting with Portainer in automated, non-interactive environments.
### Vision
By December 2019 Portainer Stack Utils:
- [ ] Has a stable API
- [ ] Doubles its [GitHub stargazers](https://github.com/greenled/portainer-stack-utils/stargazes) (+50)
- [ ] Triples its [DockerHub downloads](https://hub.docker.com/r/greenled/portainer-stack-utils) (+900)
## Supported Portainer API
This application was created for the latest Portainer API, which at the time of writing is [1.22.0](https://app.swaggerhub.com/apis/deviantony/Portainer/1.22.0).