Merge pull request #5 from reactphp-parallel/add-readme

Add readme

Author: WyriHaximus

README.md

@@ -1 +1,42 @@
-# object-proxy-annotations
+# Object Proxy Attributes
+
+Attributes for react-parallel/object-proxy
+
+![Continuous Integration](https://github.com/reactphp-parallel/object-proxy-attributes/workflows/Continuous%20Integration/badge.svg)
+[![Latest Stable Version](https://poser.pugx.org/react-parallel/object-proxy-attributes/v/stable.png)](https://packagist.org/packages/react-parallel/object-proxy-attributes)
+[![Total Downloads](https://poser.pugx.org/react-parallel/object-proxy-attributes/downloads.png)](https://packagist.org/packages/react-parallel/object-proxy-attributes)
+[![Type Coverage](https://shepherd.dev/github/reactphp-parallel/object-proxy-attributes/coverage.svg)](https://shepherd.dev/github/reactphp-parallel/object-proxy-attributes)
+[![License](https://poser.pugx.org/react-parallel/object-proxy-attributes/license.png)](https://packagist.org/packages/react-parallel/object-proxy-attributes)
+
+## Install ##
+
+To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `~`.
+
+```
+composer require react-parallel/object-proxy-attributes
+```
+
+## License ##
+
+Copyright 2020 [Cees-Jan Kiewiet](http://wyrihaximus.net/)
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.