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

Corrected spelling mistake in project name

Browse Source
This commit is contained in:
Benjamin Blake
2020-03-03 15:17:24 -07:00
parent 6a9a55dafc
commit 27972b95c7
3 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,10 +1,10 @@
The Suger Cube Client, a Gitea API client for PHP
The Sugar Cube Client, a Gitea API client for PHP
========
The Suger Cube Client allows you to send and recieve data from Gitea's RESTful API using object-oriented PHP.
The Sugar Cube Client allows you to send and recieve data from Gitea's RESTful API using object-oriented PHP.
### 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.
Under the hood, Sugar 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.
### 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).
@ -13,7 +13,7 @@ To see how Sugar Cube can be used in a real world application please refer to [A
- [ ] 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
- [ ] Submit the Sugar 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.