Skip to main content

Create a README file with workflows

Learn how to create a README.md file on a workflow.

This feature is available on Retool Cloud and will be available in subsequent releases of self-hosted Retool. Reach out to your account manager to enable README for workflows.

You can create a README from the workflow IDE to help clarify important information about your workflow for collaborators. For example, if a workflow requires certain permissions on a resource, or if it's only scheduled to run once a week.

Create a README​

To add a README to your workflow, click the title of the workflow and add your README content to the Editor README field. GitHub-flavored markdown is supported.

Click the Preview link to view the README content in HTML.

READMEs are visible from the Edit workflow details dialog box, in workflows JSON exports, and in a markdown file from Source Control.

View a README for a protected workflow​

README files can also be viewed from workflows protected with Source Control.

For more detailed information about Source Control, refer to Protect workflows with Source Control.

Once you've created the README in the workflows IDE, protect the workflow, and create and merge the pull request to view the README.md file in your repository.