meissa/provs
7
1
Fork 0
Code Issues Pull requests Projects Releases 12 Packages Wiki Activity

update README.md

Browse source
This commit is contained in:
az 2021-02-11 18:03:13 +01:00
parent 4766ffe18e
commit 297216eae9
3 changed files with 13 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
LICENSE
View file

@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2021 ansgarz
Copyright 2021 meissa GmbH
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

12
README.md Normal file
View file

@ -0,0 +1,12 @@
# Provs-core
This repo is part of the [provs framework](https://gitlab.com/domaindrivenarchitecture/provs-docs). It provides the core component with
* execution engine
* failure handling
* multiple execution processors
* execution summary and logging
* support for secrets
## Usage
For usage examples it is recommended to have a look at [provs-scripts](https://gitlab.com/domaindrivenarchitecture/provs-scripts) or provs-ubuntu-extensions.

52
Readme.md
View file

@ -1,52 +0,0 @@
# Provs-core
the core engine of the provs framework.
## Provs framework
Framework for automating shell- and other system-tasks for provisioning reasons or other purposes.
Can easily be run
* locally
* remotely
* in a docker container
* or with any self-defined custom processor
Combines the
* convenience and robustness of a modern programming language (Kotlin) with
* power of being able to use shell commands and with
* clear and detailed result summary of the built-in failure handling.
## Provs-core
Provs-core provides the core component with
* execution engine
* failure handling
* multiple execution processors
* execution summary and logging
* support for secrets
## Usage
### Run hello world
Locally:
`kotlinc -cp build/libs/provs-latest.jar -script scripts/HelloWorldLocal.kts`
Remotely:
`kotlinc -cp build/libs/provs-latest.jar -script scripts/HelloWorldRemote.kts`
### Other examples
For a bunch of usage examples please have a look at provs-ubuntu-extensions.
## License
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at
[Apache license 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.