cypress-grep icon indicating copy to clipboard operation
cypress-grep copied to clipboard

Published 20 hours ago • verified publisher icon cypress-io

docs: re-organize readme

Open Narretz opened this issue 3 years ago • 2 comments

Hi,

I've taken the liberty to re-organize the readme.

The goal was primarily to make it easier to find the relevant API faster, because not all options are available for name / tag filtering. There was also a bit of duplicated info.

The ToC should help with finding the info quicker, too.

The only things that have changed content-wise is marked in a PR comment.

  • table of contents
  • move "api" sections to the top
  • separate name + tag filter docs, because not all functionality is available for both
  • group general api info together

Narretz avatar Mar 08 '22 18:03 Narretz

@Narretz thank you for taking the time to make these changes! Sorry for the very delayed response. Could you please resolve the conflicts wit our recent v10 changes and I'll merge?

admah avatar Jun 29 '22 17:06 admah

@admah I've updated the readme with the latest changes. Also added a commit that fixes the version compat error message.

Narretz avatar Jul 23 '22 11:07 Narretz

Closes #138

admah avatar Sep 06 '22 19:09 admah

:tada: This PR is included in version 3.0.3 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] avatar Sep 06 '22 20:09 github-actions[bot]