diff --git a/README.md b/README.md index a64039d..50add4a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# multiarch-ci-libraries -Shared libraries for running the multiarch-ci-test-template based tests on a multiarch-ci-provisioner Jenkins environment. +# Multi-Arch CI Libraries +Shared libraries for running the multiarch-ci-test-template based tests on a Jenkins environment with the multiarch-ci-provisioner installed. + +## Table of Contents +- [Getting Started](#getting-started) +- [License](#license) +- [Authors](#authors) + +## Getting Started +For directions on how to get started using the library, please visit our [wiki](https://github.com/RedHat-MultiArch-QE/multiarch-ci-libraries/wiki). + +## License +This project is licensed under the Apache 2.0 License - see the LICENSE file for details. + +## Authors +This project would not be possible without the work of following people. +- [jaypoulz](https://github.com/jaypoulz/) - *Develops and maintains the current library.* +- [scoheb](https://github.com/scoheb) - *Expanded the library to support integration and configurability.*