diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..92bd1ff --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2020 avency GmbH (https://www.avency.de) & Contributors of this package + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..79455e5 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Gitea API Client + +This package provides an API client for [Gitea](https://gitea.io) API Version 1. + +*Caution! This package is still under development* + +## Getting Started + +### Prerequisites + +This package has the following requirements: + +* PHP 7.2 + +### Installing + +Install latest version via composer: + +``` +composer require avency/gitea +``` + +## Contributing + +Please read [CONTRIBUTING.md](https://github.com/avency/gitea//blob/master/CONTRIBUTING.md) +for details on our code of conduct, and the process for submitting pull requests to us. + +## Versioning + +We use [SemVer](http://semver.org/) for versioning. For the versions available, +see the [tags on this repository](https://github.com/avency/gitea/contributors). + +## Authors + +* Michael Gerdemann - [avency GmbH](https://www.avency.de) + +See also the list of [contributors](https://github.com/avency/gitea/graphs/contributors) who +participated in this project. + +## License + +This project is licensed under the MIT License - see the +[LICENSE.md](https://github.com/avency/gitea//blob/master/LICENSE.md) file for details