orchestral / canvas

Code Generators for Laravel Applications and Packages
https://packagist.org/packages/orchestra/canvas
MIT License
187 stars 12 forks source link

Improvement/documentation correction #21

Closed blhylton closed 1 year ago

blhylton commented 1 year ago

Fixed minor issue with documentation surrounding composer exec syntax with options.

When calling a binary or script with Composer, to pass command line arguments, you must also pass a blank option (--) to inform Composer to pass the arguments through.

See:

Updated commands table in README.md to be more compatible

For compatibility reasons, the pipe character preceding and following each table row. GitHub's markdown renderer doesn't care, but some editors/parsers could render this incorrectly.

See: https://www.markdownguide.org/extended-syntax/#tables

blhylton commented 1 year ago

I wanted to leave this out of the PR notes, but the primary reason for the table update was to stop my IDE from yelling about malformed Markdown in the README. If this stops this PR from being accepted for whatever reason, I can revert that commit specifically, as the other part is a bit more pressing.