I've often wished I could add an image to a contrib module or theme? I'm pretty sure that it's possible, but I never remember how and don't know where to look for instructions.

Accepted answer

You can also use HTML which is useful if you want to size, position or otherwise style the image:

<img src="https://raw.githubusercontent.com/backdrop-contrib/bee/1.x-1.x/images/bee.png" align="right" width="150" height="157">

Comments

  1. Include image in "Screenshots" directory in project. 
     

    2) Link to image in README to github repo.
     

I am told that it may take a while for the screenshot to show up on Backdropcms.org.

You can also use HTML which is useful if you want to size, position or otherwise style the image:

<img src="https://raw.githubusercontent.com/backdrop-contrib/bee/1.x-1.x/images/bee.png" align="right" width="150" height="157">

I got this additional hint in Zulip:

Hint: Themes are a bit different. They can ship with a screenshot.png, which doesn't need any adaptions in the readme - they display on B-org in listings, not on GitHub. (These previews never ever get updated on the project node on B-org, though, the first one's forever.)