README

A simple PHP framework that is not tied to a web interface.

Installation

Nectary is currently only available through GitHub, to install, add the following configuration to your composer.json:

{
    "repositories": [
        {
            "url": "https://github.com/gios-asu/nectary.git",
            "type": "git"
        }
    ],
    "require": {
        "gios-asu/nectary": "^1.0.0"
    }
}

Developing

If you add a class or change a namespace, remember to run composer update in order to add the class to the autoloader.

Check your code coverage with vendor/bin/phpunit --coverage-html ./coverage.

Documentation

Documentation can be found on the Github IO pages for this repo.

To generate the documentation, use phpDox. After running composer install, simply run ./vendor/bin/phpdox in the root of the project.