yoozi/golem

PHP development toolkit for Yoozi RD team.

Project Golem

, _(*1)

What is Project Golem?

Project Golem is a PHP development toolkit crafted by R&D team from Yoozi Inc. It consists of a growing collection of loosely coupled high-level PHP libraries, most of which are derived from our own products to solve real world problems., _(*2)

• Miner: Miner is a PHP library that extracting metadata and interesting text content (like author, summary, and etc.) from HTML pages. It acts like a simplified HTML metadata parser in Apache Tika.
• Email: Simple toolkits to help processing email related tasks, such as a Email Address Parser and etc.
• Notification: A simple library to wrap common notification transports, such as email, socket.io and etc.

Golem can be installed as a whole package via Composer. However, to keep dependency and installation footprint as low as possible, each library within Golem can also be installed as a standalone package., _(*3)

System Requirements

• PHP >= 5.3.0
• You will need Composer installed to load the dependencies of Golem libraries.
• Some libraries may require extra server components and/or extensions installed.

Installation

The best and easy way to install the Golem package is via Composer., _(*4)

1. Open your composer.json and add the following to the require array:, _(*5)

   "yoozi/golem": "1.0.*"
   

2. Run Composer to install or update the new package dependencies., _(*6)

   php composer install
   

   or, _(*7)

   php composer update
   

Versioning

For transparency and insight into our release cycle, releases will be numbered with the follow format:, _(*8)

<major>.<minor>.<patch>

And constructed with the following guidelines:, _(*9)

• Breaking backwards compatibility bumps the major
• New additions without breaking backwards compatibility bumps the minor
• Bug fixes and misc changes bump the patch

For more information on semantic versioning, please visit http://semver.org/., _(*10)

Testing

To run the tests you first need to install PHPUnit., _(*11)

$ phpunit

Changelog

See changelogs here., _(*12)

Authors

See authors and contributors here., _(*13)

License

Copyright 2014 Yoozi, Inc., _(*14)

Licensed under the MIT License., _(*15)