diff --git a/LICENSE b/LICENSE index 25665d9..bc95d3a 100644 --- a/LICENSE +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8abd8a1 --- /dev/null +++ b/README.md @@ -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. diff --git a/Readme.md b/Readme.md deleted file mode 100644 index d5e12ab..0000000 --- a/Readme.md +++ /dev/null @@ -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.