Skip to content

Commit

Permalink
Merge pull request #46 from Ocramius/hotfix/issue-#33-better-project-…
Browse files Browse the repository at this point in the history
…description

Cleaning up documentation
  • Loading branch information
Ocramius committed May 18, 2013
2 parents 1363695 + 1b6feb0 commit 8b235ca
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* The project will follow strict [object calisthenics](http://www.slideshare.net/guilhermeblanco/object-calisthenics-applied-to-php)
* Any contribution must provide tests for additional introduced conditions
* Any un-confirmed issue needs a failing test case before being accepted
* Pull requests must be sent from a new hotfix/feature branch, not from `master`.

## Installation

Expand All @@ -18,7 +19,7 @@ You will then need to run a composer installation:
```sh
cd ProxyManager
curl -s https://getcomposer.org/installer | php
php composer.phar update --dev
php composer.phar update
```

## Testing
Expand All @@ -29,4 +30,6 @@ The PHPUnit version to be used is the one installed as a dev- dependency via com
./vendor/bin/phpunit
```

Accepted coverage for new contributions is 80%. Any contribution not satisfying this requirement won't be merged.
Accepted coverage for new contributions is 80%. Any contribution not satisfying this requirement
won't be merged.

13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

[![Build Status](https://travis-ci.org/Ocramius/ProxyManager.png?branch=master)](https://travis-ci.org/Ocramius/ProxyManager) [![Dependency Status](https://www.versioneye.com/package/php--ocramius--proxy-manager/badge.png)](https://www.versioneye.com/package/php--ocramius--proxy-manager) [![Coverage Status](https://coveralls.io/repos/Ocramius/ProxyManager/badge.png?branch=master)](https://coveralls.io/r/Ocramius/ProxyManager)

This library aims at providing abstraction for generating various kinds of proxy classes.
This library aims at providing abstraction for generating various kinds of [proxy classes](http://marco-pivetta.com/proxy-pattern-in-php/).

The idea was originated by a [talk about Proxies in PHP OOP](http://marco-pivetta.com/proxy-pattern-in-php/) that I gave
at the [@phpugffm](https://twitter.com/phpugffm) in January 2013.
Currently, this project supports generation of **Virtual Proxies** and **Smart References**.
Additionally, it can generate a small high-performance **Hydrator** class to optimize transition
of data from and into your objects.

## Installation

Expand Down Expand Up @@ -127,3 +128,9 @@ in the `docs/` directory.

Please read the [CONTRIBUTING.md](https://github.com/Ocramius/ProxyManager/blob/master/CONTRIBUTING.md) contents if you
wish to help out!

## Credits

The idea was originated by a [talk about Proxies in PHP OOP](http://marco-pivetta.com/proxy-pattern-in-php/) that I gave
at the [@phpugffm](https://twitter.com/phpugffm) in January 2013.

0 comments on commit 8b235ca

Please sign in to comment.