Skip to content

Commit

Permalink
Merge branch 'master' of github.com:ukfast/sdk-php
Browse files Browse the repository at this point in the history
  • Loading branch information
Gman98ish committed Apr 26, 2019
2 parents 99f2679 + 7b41635 commit a11bb57
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.idea
composer.lock
vendor
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
CONTRIBUTING
============

Contributions are welcome and we look forward to seeing what you can bring to the project.

We do reserve the right to reject changes that we feel will not benefit users or take the project in a direction we do not wish to take.
We recommend discussing any large changes with us prior to making your changes, you can do this via an issue or email if you prefer.


Issues
------

Issues should include a title and clear description with as much relevant information as possible.

If you think you have identified a security vulnerability, please contact our team via **[email protected]** who will get back to you as soon as possible.


Submitting Changes
------------------

Before submitting your [pull request](https://help.github.com/en/articles/about-pull-requests),
please make sure that the coding standards are respected and that all tests are passing.

Pull requests should provide an overview of the changes made so it is clear what you are trying to achieve, this will help us when reviewing your changes.

Commit messages should be clear, we dont mind one-line messages for small changes
but larger changes should follow [The Seven Rules](https://chris.beams.io/posts/git-commit/) set by Chris Beams.

We dont mind squashing small changes to tidy things up but please dont squash an entire branch as this can hinder code reviews.


Coding Standards
---------------
This library uses the [PSR2 Coding Standard](https://www.php-fig.org/psr/psr-2/).


Testing
-------
Please ensure all new functionality is matched with appropriate tests, we will advise if we feel more is needed.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# sdk-php
UKFast API client for PHP
UKFast API PHP client
=====================

A PHP client library for connecting your application(s) to the UKFast APIs.

To use this package, you will need a UKFast account. Sign up for free at [ukfast.co.uk][1],
and refer to the [Getting Started][2] section of our developer documentation for more information on consuming our APIs.


Installation
------------

The recommended way to install this package is through [composer](https://getcomposer.org).

This package does currently support PHP 5.6+, but we recommend moving to 7.1+ as soon as possible.


Contributing
------------

We welcome contributions that will benefit our users,
please see [CONTRIBUTING](CONTRIBUTING.md) for details on how to get involved.


License
-------

This SDK is released under the [MIT License][license]


[1]: https://www.ukfast.co.uk/myukfast-signup.html??utm_source=github&utm_medium=link&utm_campaign=apio
[2]: https://developers.ukfast.io/getting-started?utm_source=github&utm_medium=link&utm_campaign=apio
5 changes: 4 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@
"description": "UKFast SDK for PHP",
"type": "library",
"license": "MIT",
"support": {
"email": "[email protected]"
},
"minimum-stability": "stable",
"require": {
"php": ">=5.5",
"php": ">=5.6",
"ext-json": "*",
"guzzlehttp/guzzle": "^6.3"
},
Expand Down

0 comments on commit a11bb57

Please sign in to comment.