Skip to content
This repository has been archived by the owner on Apr 23, 2022. It is now read-only.

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
paul-thebaud committed Mar 9, 2018
1 parent 8f79c46 commit 182cd6d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
10 changes: 7 additions & 3 deletions README.md
Expand Up @@ -9,9 +9,12 @@
[![Total Downloads][ico-downloads]][link-downloads]

PhpUnitGen is an open source development tool which will help you writing your unit tests for PHPUnit 6 / 7:

* Generate unit skeleton for all PHP files including classes, traits, interfaces and global functions.
* Automatically generate a few simple unit tests (like getter / setter methods tests, class instantiation).

You can try this package on a web application, at [phpunitgen.io](https://phpunitgen.io)

__Version 2 of PhpUnitGen is now available, but be careful, it breaks the PhpUnitGen 1.x.x API.__

## Package structure
Expand All @@ -38,7 +41,8 @@ $ composer require --dev paulthebaud/phpunit-generator ^2.0

## Basic usages

PhpUnitGen basic usage is from command line with the following command. Use this command in project root directory.
PhpUnitGen basic usage is from command line with the following command.
Use this command in project root directory.

```bash
$ php ./vendor/bin/phpunitgen
Expand Down Expand Up @@ -81,12 +85,12 @@ $ php ./vendor/bin/phpunitgen --default --dir source/dir target/dir

__Note__: When parsing a directory, PhpUnitGen will also parse sub-directories.

PhpUnitGen can also be used online on [this website](https://phpunitgen.io).

You can find documentation files in the `documentation` directory of this repository:
* [Various usage: console, website, PHP code](documentation/USAGE.md).
* [Annotations usage in your PHP files](documentation/ANNOTATIONS.md).

PhpUnitGen can also be used online on [this website (phpunitgen.io)](https://phpunitgen.io).

## Running tests

```bash
Expand Down
12 changes: 6 additions & 6 deletions documentation/USAGE.md
Expand Up @@ -14,6 +14,12 @@ If you find any issue, please report them [here](https://github.com/paul-thebaud

__Note__: All across your generated tests skeletons, you will find `@todo` PHP annotations to complete them.

#### Website usage

PhpUnitGen is available online:

[https://phpunitgen.herokuapp.com/](https://phpunitgen.io/)

#### Console usage

When you install this package, you can use the command line to generate your unit tests skeleton.
Expand Down Expand Up @@ -95,12 +101,6 @@ It will also parse sub-directories. *null* if you have no directory to parse.
and put the generated unit tests skeletons in your target file (an array value).
*null* if you have no file to parse.

#### Website usage

PhpUnitGen is available online on an Heroku server:

[https://phpunitgen.herokuapp.com/](https://phpunitgen.io/)

#### PHP code usage

Here is an example of using PhpUnitGen in a PHP script.
Expand Down

0 comments on commit 182cd6d

Please sign in to comment.