diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d83f9ba --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# Change log + +All notable changes to this project will be documented in this file. +This project adheres to [Semantic Versioning](http://semver.org/). + +## [1.0.0] - TBC + +* Magic Get / Set methods +* toArray() method +* toJson() method \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6c93af3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +Contributions and suggestion are **welcome** and will be fully **credited**. + +We accept contributions via Pull Requests on [Github](https://github.com/mikebarlow/GetSet). + +## Pull Requests + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. +- **Document any change in behaviour** - Make sure the README / CHANGELOG and any other relevant documentation are kept up-to-date. +- **Consider our release cycle** - We try to follow semver. Randomly breaking public APIs is not an option. +- **Create topic branches** - Don't ask us to pull from your master branch. +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting. diff --git a/README.md b/README.md index 310e7b7..f27b575 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,67 @@ # GetSet [![Author](http://img.shields.io/badge/author-@mikebarlow-red.svg?style=flat-square)](https://twitter.com/mikebarlow) -[![Latest Version](https://img.shields.io/github/release/mikebarlow/mycal.svg?style=flat-square)](https://github.com/mikebarlow/GetSet/releases) +[![Latest Version](https://img.shields.io/github/release/mikebarlow/getset.svg?style=flat-square)](https://github.com/mikebarlow/GetSet/releases) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://github.com/mikebarlow/GetSet/blob/master/LICENSE) [![Build Status](https://img.shields.io/travis/mikebarlow/GetSet/master.svg?style=flat-square)](https://travis-ci.org/mikebarlow/GetSet) ## Introduction -GetSet is a PSR-2 compliant trait to be used for adding magic getters / setters to objects. \ No newline at end of file +GetSet is a PSR-2 compliant trait to be used for adding magic getters / setters to objects. + +## Requirements + +### Composer + +GetSet requires the following: + +* "php": ">=5.6.0" + +And the following if you wish to run in dev mode and run tests. + +* "phpunit/phpunit": "~5.7" +* "squizlabs/php_codesniffer": "~2.0" + +## Installation + +### Composer + +Simplest installation is via composer. + + composer require snscripts/getset 0.* + +or adding to your projects `composer.json` file. + + { + "require": { + "snscripts/getset": "1.*" + } + } + +### Setup + +To initiate GetSet simply `use` the trait within your class + + class MyClass + { + use \Snscripts\GetSet\GetSet; + + ... + } + +## Usage + + + + +## Changelog + +You can view the changelog [HERE](https://github.com/mikebarlow/GetSet/blob/master/CHANGELOG.md) + +## Contributing + +Please see [CONTRIBUTING](https://github.com/mikebarlow/GetSet/blob/master/CONTRIBUTING.md) for details. + +## License + +The MIT License (MIT). Please see [License File](https://github.com/mikebarlow/GetSet/blob/master/LICENSE) for more information. \ No newline at end of file