Skip to content

Commit

Permalink
docs: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MontealegreLuis committed Jul 29, 2021
1 parent 26e3e1a commit dd58fa1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 12 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
[![Code Coverage][coverage-badge]][coverage]
[![Infection MSI](https://badge.stryker-mutator.io/github.com/montealegreluis/phuml/master)](https://dashboard.stryker-mutator.io/reports/github.com/montealegreluis/phuml/master)
[![Latest Stable Version][stable-badge]][packagist]
[![Minimum PHP Version][php-version-badge]][php]
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.0-8892BF.svg?style=flat-square)](https://php.net/)

phUML is a fully automatic [UML][uml] class diagram generator written in [PHP][php].
phUML is a fully automatic [UML][uml] class diagram generator written in [PHP](https://php.net/).
It creates a class diagram from an Object-Oriented codebase based on the UML specification.

## Installation
Expand All @@ -17,10 +17,10 @@ It creates a class diagram from an Object-Oriented codebase based on the UML spe
The official phUML Docker image can be found on [Docker Hub](https://hub.docker.com/r/montealegreluis/phuml/).

```bash
docker pull montealegreluis/phuml:4.0.0
docker pull montealegreluis/phuml:5.0.0
```

You can replace `4.0.0` with any of the available [tags](https://hub.docker.com/r/montealegreluis/phuml/tags?page=1&ordering=last_updated)
You can replace `5.0.0` with any of the available [tags](https://hub.docker.com/r/montealegreluis/phuml/tags?page=1&ordering=last_updated)

### Composer

Expand Down Expand Up @@ -73,8 +73,6 @@ Special thanks to all of these [awesome contributors][contributors].
[codebase]: https://github.com/jakobwesthoff/phuml/tree/master/src
[stable-badge]: https://img.shields.io/packagist/v/phuml/phuml.svg?style=flat-square
[packagist]: https://packagist.org/packages/phuml/phuml
[php-version-badge]: https://img.shields.io/badge/php-%3E%3D%207.4-8892BF.svg?style=flat-square
[php]: https://php.net/
[luis]: https://github.com/MontealegreLuis
[jakob]: https://github.com/jakobwesthoff
[contributors]: https://github.com/MontealegreLuis/phuml/contributors
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
The official phUML Docker image can be found on [Docker Hub](https://hub.docker.com/r/montealegreluis/phuml/).

```bash
docker pull montealegreluis/phuml:4.0.0
docker pull montealegreluis/phuml:5.0.0
```

You can replace `4.0.0` with any of th available [tags](https://hub.docker.com/r/montealegreluis/phuml/tags?page=1&ordering=last_updated)
You can replace `5.0.0` with any of th available [tags](https://hub.docker.com/r/montealegreluis/phuml/tags?page=1&ordering=last_updated)

## Composer

Expand Down
6 changes: 2 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
[![Code Coverage][coverage-badge]][coverage]
[![Infection MSI](https://badge.stryker-mutator.io/github.com/montealegreluis/phuml/master)](https://dashboard.stryker-mutator.io/reports/github.com/montealegreluis/phuml/master)
[![Latest Stable Version][stable-badge]][packagist]
[![Minimum PHP Version][php-badge]][php]
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.0-8892BF.svg?style=flat-square)](https://php.net/)

phUML is a fully automatic [UML][uml] class diagram generator written in [PHP][php].
phUML is a fully automatic [UML][uml] class diagram generator written in [PHP](https://php.net/).
It creates a class diagram from an Object-Oriented codebase based on the UML specification.

To successfully create UML diagrams with phUML you will need to install the [graphviz][graphviz] toolkit.
Expand All @@ -33,5 +33,3 @@ You can take a look at the complete image by clicking [here][diagram].
[coverage]: https://scrutinizer-ci.com/g/MontealegreLuis/phuml/?branch=master
[stable-badge]: https://img.shields.io/packagist/v/phuml/phuml.svg?style=flat-square
[packagist]: https://packagist.org/packages/phuml/phuml
[php-badge]: https://img.shields.io/badge/php-%3E%3D%207.4-8892BF.svg?style=flat-square
[php]: https://php.net/

0 comments on commit dd58fa1

Please sign in to comment.