From 14d770e1348c9e9992c89cce97e418db87090543 Mon Sep 17 00:00:00 2001 From: Akihito Koriyama Date: Mon, 27 May 2024 09:44:20 +0900 Subject: [PATCH 1/2] Fix typos in README.md documentation This commit corrects minor spelling errors within the README file, ensuring proper understanding of the instructions related to PHP version support and the use of PlantUML. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d52da6..1e0a143 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ OPTIONS --disable-class-name-summary describe classname without Class summary of document comment. --php5 parse php source file as php5. --php7 parse php source file as php7. - --php8 parse php source file as php8. (not suppoted) + --php8 parse php source file as php8. (not supported) --header='header string' additional header string. You can specify multiple header values. --include='wildcard' include target file pattern. (default: `*.php`) You can specify multiple include patterns. --exclude='wildcard' exclude target file pattern. You can specify multiple exclude patterns. @@ -152,7 +152,7 @@ $ vendor/bin/php-class-diagram test/fixtures/no-namespace @enduml ``` -Use PlnatUML to convert the PlantUML script to an image. +Use PlantUML to convert the PlantUML script to an image. ![PlantUML output image.](doc/images/output.png) From e56c3dc4d2872c1c81a14d3e3292b6b35e311ebf Mon Sep 17 00:00:00 2001 From: Akihito Koriyama Date: Mon, 27 May 2024 09:47:13 +0900 Subject: [PATCH 2/2] Correct capitalization in README.md This commit updates the capitalization in a sentence in the README.md file. The sentence now starts with a capital letter, improving readability and adherence to proper grammar. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e0a143..a6d91d4 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ $ composer require --dev smeghead/php-class-diagram ``` Now, you can execute `./vendor/bin/php-class-diagram`. -for instance, try to display help message. +For instance, try to display help message. ```bash $ vendor/bin/php-class-diagram --help