jwpage/composerdoc

Console tool for displaying package documentation.

Installs: 12

Dependents: 0

Stars: 17

Watchers: 2

Forks: 1

Language: PHP

v2.0.0 2013-07-10 00:56 UTC

README

Build Status

Composerdoc is a tool that allows you to dump a listing of the required packages within your project to a markdown format for documentation purposes.

Installation

Add this to your composer.json by running composer.phar require jwpage/composerdoc --dev.

Or alternatively, as Composerdoc is a documentation tool, you can install it separately and run it with the --path option.

echo -n '{ "require": { "jwpage/composerdoc": "*" } }' > composer.json
composer.phar install

Usage

composerdoc dump

To generate composerdoc output:

./vendor/bin/composerdoc --path <path_to_composer.json_dir>

To include dev requirements:

./vendor/bin/composerdoc --dev

To include requirements of requirements:

./vendor/bin/composerdoc --sub

composerdoc check

You can use composerdoc to check if a README file has the latest composerdoc information.

./vendor/bin/composerdoc --path <README.markdown>

This command takes the same options as the composerdoc dump command.

composerdoc update

You can also automatically update a README file with the latest composerdoc information in one command.

./vendor/bin/composerdoc --path <README.markdown>

This command takes the same options as the composerdoc dump command.

Example Output

Required Packages

Dev Packages

Running Tests

First, install PHPUnit with composer.phar install --dev, then run ./vendor/bin/phpunit.