Otherway/sugar-cube-client
2
0
Fork 0
mirror of https://github.com/sitelease/sugar-cube-client.git synced 2025-10-30 03:22:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated composer.json and README file

Browse Source 
+ Changed the name of the project to "sugar-cube-client"
+ Updated the composer.json file
+ Updated the README file
This commit is contained in:
Benjamin Blake
2020-03-03 14:53:43 -07:00
parent 8004781e62
commit 739d27a1db
2 changed files with 27 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,16 +1,21 @@
# Gitea for PHP
![Runtime](https://img.shields.io/packagist/php-v/sab-international/gitea.svg) ![Release](https://img.shields.io/packagist/v/sab-international/gitea.svg) ![License](https://img.shields.io/packagist/l/sab-international/gitea.svg) ![Downloads](https://img.shields.io/packagist/dt/sab-international/gitea.svg) ![Coverage](https://coveralls.io/repos/github/sab-international/gitea.php/badge.svg) ![Build](https://travis-ci.com/sab-international/gitea.php.svg)
The Suger Cube Client, a Gitea API client for PHP
========
[Gitea](https://gitea.io) client library, in [PHP](https://secure.php.net).
The Suger Cube Client allows you to send and recieve data from Gitea's RESTful API using object-oriented PHP.
## Documentation
- [User guide](https://dev.sabcomputer.com/gitea.php)
- [API reference](https://dev.sabcomputer.com/gitea.php/api)
### How does it work?
Under the hood, Suger Cube uses the [Guzzle Library](http://docs.guzzlephp.org/en/stable/) to make and send requests to [Gitea's RESTful API](https://try.gitea.io/api/swagger) routes. It then converts the returned JSON response data into PHP objects which you can use to easily query the data.
## Development
- [Git repository](https://github.com/sab-international/gitea.php)
- [Packagist package](https://packagist.org/packages/sab-international/gitea)
- [Submit an issue](https://github.com/sab-international/gitea.php/issues)
### Real world Example
To see how Sugar Cube can be used in a real world application please refer to [Acapella's code base](https://github.com/sitelease/acappella) (e.g. [line 39](https://github.com/sitelease/acappella/blob/1.0.0/src/Application/GiteaRepositoryManager.php#L39) of GiteaRepositoryManager.php).
## License
[Gitea for PHP](https://dev.sabcomputer.com/gitea.php) is distributed under the MIT License.
### What's next?
- [ ] Add Example code to the README
- [ ] Create PHPUnit tests for each API requester
- [ ] Create more API requesters for Gitea's API routes
- [ ] Submit the Suger Cube composer package to Packagist
### Credits
* First thank you goes out to the folks over on the [Gitea.php](https://github.com/sab-international/gitea.php) project. Your Model and Push Event objects provided the foundation of this project.
* Next thank you goes to those who worked on [CompoLab](https://github.com/bricev/CompoLab). It was during the process of porting your great project to Gitea that we made this client.
* And last but not least, a big shout out to everyone who has contributed to [Gitea](https://github.com/go-gitea/gitea). Without your project there wouldn't be any API to make the client for ;)