You can set your project's description and README to share the purpose of your project, provide instructions on how to use the project, and include any relevant links.

{% data reusables.projects.project-settings %}
1. To add a short description to your project, under "Add a description", type your description in the text box  and click **Save**.
  ![Screenshot showing the 'Add my description' settings](/assets/images/help/projects-v2/edit-description.png)
1. To update your project's README, under "README", type your content in the text box.
   - You can format your README using Markdown. For more information, see "[Basic writing and formatting syntax](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)."
   - To toggle between the text box and a preview of your changes, click {% octicon "eye" aria-label="The preview icon" %} or {% octicon "pencil" aria-label="The edit icon" %}.
  ![Screenshot showing editing a project's README](/assets/images/help/projects-v2/edit-readme.png)
1. To save changes to your README, click **Save**.
  ![Screenshot showing the 'Save' button for a project's README](/assets/images/help/projects-v2/save-readme-button.png)

You can view and make quick changes to your project description and README by navigating to your project and clicking {% octicon "sidebar-expand" aria-label="The sidebar icon" %} in the top right.