readme.md

SugaredRim\Sami

Sami sweetened with ease 🍒

SugaredRim\Sami takes an opinionated view of generating documentation with Sami, it is preconfigured to get you up and running as quickly as possible.

Install

$ composer require --dev sugared-rim/sami

Usage

Instead of creating a configuration file and running sami.phar update /path/to/config.php, just run sugared-rim-sami - that's it:

{
    ...
    "require-dev": {
        "sugared-rim/sami": ...
    },
    "scripts": {
        "doc": "sugared-rim-sami"
    }
}

Configuration

You may overwrite some options by putting it in your composer.json.

Some of the default settings:

{
    ...
    "scripts": {
        "doc": "sugared-rim-sami"
    },
    "extra": {
        "sugared-rim/sami": {
            "files": "src",
            "filter": "SugaredRim\\Sami\\ProtectedFilter",
            "build_dir": "build/sami",
            "cache_dir": "build/cache/sami"
        }
    }
}

All extra.sugared-rim/sami options are passed through the Sami constructor, except:

• filter: A FQCN of the filter to use, sugared-rim-sami will create an instance for you.

License

MIT © Michael Mayer