feat: Add readme and license

Add the basic readme and MIT license file.
This commit is contained in:
Michael Gerdemann
2020-01-17 08:23:08 +01:00
parent 0a6c32a6f2
commit d4bb8a6108
2 changed files with 64 additions and 0 deletions

43
README.md Normal file
View File

@ -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