diff --git a/README.md b/README.md index 05f5ffe..9759e94 100644 --- a/README.md +++ b/README.md @@ -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 ;) diff --git a/composer.json b/composer.json index d034f64..6d541ea 100644 --- a/composer.json +++ b/composer.json @@ -1,26 +1,23 @@ { - "description": "Gitea client library.", - "homepage": "https://github.com/mooror/gitea.php", - "license": "MIT", - "name": "sitelease/gitea-php", + "name": "sitelease/suger-cube-client", + "description": "Suger Cube Client", + "homepage": "https://github.com/sitelease/suger-cube-client", "type": "library", + "license": "MIT", "authors": [ - {"email": "contact@sabcomputer.com", "name": "SAB International", "homepage": "http://www.sabcomputer.com"}, - {"email": "cedric@belin.io", "name": "Cédric Belin", "homepage": "https://belin.io"}, - {"email": "ben@sitelease.ca", "name": "Benjamin Blake", "homepage": "https://www.sitelease.ca"} + {"email": "contact@sabcomputer.com", "name": "SAB International (old)", "homepage": "http://www.sabcomputer.com"}, + {"email": "cedric@belin.io", "name": "Cédric Belin (old)", "homepage": "https://belin.io"}, + {"email": "ben@sitelease.ca", "name": "Benjamin Blake (current)", "homepage": "https://www.sitelease.ca"} ], "autoload": { "psr-4": {"Gitea\\": "src/"} }, - "autoload-dev": { - "files": ["vendor/phpunit/phpunit/src/Framework/Assert/Functions.php"], - "psr-4": {"Gitea\\": "test/"} - }, "keywords": [ "api", "client", "git", "gitea", + "suger", "scm", "vcs" ], @@ -32,18 +29,11 @@ "guzzlehttp/guzzle": "~6.0" }, "require-dev": { - "cedx/coveralls": "^10.1.0", - "consolidation/robo": "^1.4.9", - "henrikbjorn/lurker": "^1.2.0", "phpstan/phpstan": "^0.11.5", "phpunit/phpunit": "^8.1.2" }, - "scripts": { - "coverage": "robo coverage", - "test": "robo test" - }, "support": { - "docs": "https://github.com/mooror/gitea.php", - "issues": "https://github.com/mooror/gitea.php/issues" + "docs": "https://github.com/sitelease/suger-cube-client", + "issues": "https://github.com/sitelease/suger-cube-client/issues" } }