From a20d3ff9e5b393465aadd53713f1285ff472443c Mon Sep 17 00:00:00 2001 From: jerger Date: Fri, 25 Feb 2022 17:03:55 +0100 Subject: [PATCH] adjust readme --- README.md | 40 +++++++++++++++++----------------------- 1 file changed, 17 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 0e0ac08..f5d99a4 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ -# Provs framework -Provs is a framework for automating tasks for provisioning reasons and other purposes. +# provs +[![pipeline status](https://gitlab.com/domaindrivenarchitecture/provs/badges/master/pipeline.svg)](https://gitlab.com/domaindrivenarchitecture/provs/-/commits/master) -It combines +[DeltaChat chat over e-mail](mailto:buero@meissa-gmbh.de?subject=community-chat) | [team@social.meissa-gmbh.de team@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@team) | [Website & Blog](https://domaindrivenarchitecture.org) + +## Purpose + +provs provide cli-tools for provisioning desktop // server +* provs-desktop minimal - provides as minimal virtual-box able setup (e.g. swappiness / randomutils) +* provs-desktop offic - provides enhancements like zim / gopass / fakturama +* provs-desktop ide - provides development environments for java / kotlin / python / clojure / terraform +* provs-server k3s - provides a production ready & dualstack able k3s setup + +In general provs combines * being able to use the power of shell commands * a clear and detailed result summary of the built-in execution handling (incl. failure handling and reporting) * the convenience and robustness of a modern programming language +## Status -### Write once, run everywhere - -Tasks can be run - -* locally -* remotely -* in a local docker container -* in a remote container - -Additionally, it is possible to define a custom processor if needed. - - -## Usage +under development - we are working hard on seting up our environments using provs. +## Try out ### Prerequisites * A **Java Virtual machine** (JVM) is required. @@ -29,7 +29,7 @@ Additionally, it is possible to define a custom processor if needed. * Make the jar-file executable by `chmod +x provs-desktop.jar` * For server functionality (e.g. k3s) download the latest `provs-server.jar` from: https://gitlab.com/domaindrivenarchitecture/provs/-/releases -### Usage format +### provs-desktop `provs-desktop.jar []` @@ -47,13 +47,7 @@ Additionally, it is possible to define a custom processor if needed. **options** * `-p` for interactive password question - -#### Show usage options - -`provs-desktop.jar -h` - ### Examples - #### Provision a basic desktop workplace locally `provs-desktop.jar basic local`