diff --git a/LICENSE.md b/LICENSE.md index a5af127..15b3393 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -The Suger Cube Client (formerly gitea.php) is released with MIT License: +The Sugar Cube Client (formerly gitea.php) is released with MIT License: Copyright © 2018 - 2019 SAB International Copyright © 2020 siteLease Web Solutions diff --git a/README.md b/README.md index 9759e94..f00ac92 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/composer.json b/composer.json index 6d541ea..9074376 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { - "name": "sitelease/suger-cube-client", - "description": "Suger Cube Client", - "homepage": "https://github.com/sitelease/suger-cube-client", + "name": "sitelease/sugar-cube-client", + "description": "A sweet Gitea API client for PHP", + "homepage": "https://github.com/sitelease/sugar-cube-client", "type": "library", "license": "MIT", "authors": [ @@ -17,7 +17,7 @@ "client", "git", "gitea", - "suger", + "sugar", "scm", "vcs" ], @@ -33,7 +33,7 @@ "phpunit/phpunit": "^8.1.2" }, "support": { - "docs": "https://github.com/sitelease/suger-cube-client", - "issues": "https://github.com/sitelease/suger-cube-client/issues" + "docs": "https://github.com/sitelease/sugar-cube-client", + "issues": "https://github.com/sitelease/sugar-cube-client/issues" } }