SaltfishTry for free

How to Add Images to Github ReadMe

·2 min read
In this article

Adding images to your GitHub README file is an excellent way to make your project documentation more engaging and informative. Visual elements like screenshots, diagrams, and logos help visitors quickly understand what your project does and how to use it.

This tutorial will walk you through the complete process of uploading images to your GitHub repository and displaying them in your README file. Whether you're creating a new README or updating an existing one, these steps will help you enhance your project's presentation.

Here's how to add images to github readme in GitHub

  1. Navigate to the repository you want to modify.
  2. Locate the README section and select 'Add a README'.
  3. Use the file attachment option by dragging, dropping, selecting, or pasting your images.
  4. Wait for the image to upload and appear in the editor.
  5. Write a descriptive commit message explaining what you've added.
  6. Include an extended description providing more context about your changes.
  7. Click 'Commit changes' to save your README with the new images.

Your turn to show how it works.

Build a walkthrough of your product with Saltfish, then share it with your customers.

Create a guide with Saltfish

Frequently Asked Questions

GitHub supports common image formats including PNG, JPG, JPEG, GIF, and WebP. PNG and JPG are the most widely used formats for README files. Animated GIFs are also supported and can be great for demonstrating functionality.