Adding Images to README.md on GitHub

I had been using SVN before and only truly started using Git a few months ago. I had briefly used GitHub during KDD2013.

Recently, I wanted to polish my programs properly – comments and descriptions are essential and should be written with care.

I encountered a problem: how to add images to a README.md file.

Here is the solution I used:

Create an image folder within your project folder, place the images you want to display in the README.md, and commit that folder to GitHub. Through the preview, you can obtain the image’s URL on GitHub.

README.md supports the following image markup: <img data-original="image-url" src="http://blog.coinidea.com/wp-content/themes/9IPHP/images/lazy_loading.gif" alt="image" />

Example:

https://github.com/hujiulin/WordConverter