mirror of
https://github.com/avency/Gitea.git
synced 2025-10-29 18:52:33 +01:00
feat: Add readme and license
Add the basic readme and MIT license file.
This commit is contained in:
43
README.md
Normal file
43
README.md
Normal 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
|
||||
Reference in New Issue
Block a user