Skip to content

Improve README#30

Merged
laoneo merged 11 commits intojoomla-projects:mainfrom
muhme:improve-readme
Jul 30, 2024
Merged

Improve README#30
laoneo merged 11 commits intojoomla-projects:mainfrom
muhme:improve-readme

Conversation

@muhme
Copy link
Contributor

@muhme muhme commented Jul 27, 2024

The README.md has been improved to make it - hopefully - worth reading.

  • Added version badge.
  • The installation, the usage and the logging format are explained.
  • Grouping the commands in a - hopefully - better order for first-time readers.
  • Parameters are explained more in detail.
  • Example usages are given (and tested).
  • Some linking to related commands are inserted.
  • Some restrictions are documented.

skipTour is intentionally not documented, hopefully we can still combine the functionality with cancelTour.

Are you missing something important?

@laoneo laoneo merged commit db6170e into joomla-projects:main Jul 30, 2024
@laoneo
Copy link
Contributor

laoneo commented Jul 30, 2024

Merging this for now, we can still fix more afterwards.

@muhme muhme deleted the improve-readme branch July 31, 2024 04:11
muhme added a commit to muhme/joomla-cypress that referenced this pull request Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants