Deploy

App README

Tell people what the app does before they open it.

Every app can have a short README in Markdown: what it does, who it is for, where its data comes from, and how to use it. In a company workspace, people see it in the company directory before they open the app, and admins read it when they review a directory submission.

Add a README when you deploy

Your AI tool usually writes one for you and sends it with the deploy. You can ask for it:

Deploy this and include a README explaining how the sales team should use it.

Each version keeps the README it was deployed with.

Edit it when you submit to the directory

The Submit to directory form shows the README, and you can change it there before you send it. See Publish to the company.