diff --git a/docs/guides/cloud/projects.mdx b/docs/guides/cloud/projects.mdx index 678039d520..74df091da9 100644 --- a/docs/guides/cloud/projects.mdx +++ b/docs/guides/cloud/projects.mdx @@ -306,29 +306,34 @@ test count to other developers viewing your project's README file. ### Create a README badge -1. In your Cypress Cloud account, select the project for which you’d like to -1. On the Project Settings page, scroll down to the README Badges section and +1. In your Cypress Cloud account, select the project for which you’d like to add + a badge. +2. On the Project Settings page, scroll down to the README Badges section and click “Configure Badge”. -- **Note**: README badges are currently only available for public projects. +:::caution + +**NOTE:** README badges are currently only available for **public** projects. + +::: -1. A configuration modal will appear. The Project ID will be pre-filled with the +3. A configuration modal will appear. The Project ID will be pre-filled with the ID associated with the project you selected. You can choose to designate a specific branch, or leave this field blank to always use the latest build in the project. -1. Next, style your badge. Flat is the default styling and is most commonly +4. Next, style your badge. Flat is the default styling and is most commonly used, but 5 style options are available. -1. Select the badge type to change the amount and type of information that's +5. Select the badge type to change the amount and type of information that's displayed. Simple status will show only whether tests are passing or failing. Detailed status will show the number of tests that were passed, failed, or skipped. Test count will show how many tests are included in your project. -1. Once you've selected all your settings, check out the preview and make sure +6. Once you've selected all your settings, check out the preview and make sure everything looks just the way you like it. -1. 🎉 Your badge is ready to be embedded. Copy the markdown at the bottom of the +7. 🎉 Your badge is ready to be embedded. Copy the markdown at the bottom of the Configure Badge modal, and embed it in your project's README file for everyone to see!