Add chart image to readme

AstroDraw / AstroChart

A free and open-source TypeScript library for generating SVG charts to display planets in astrology.

https://astrodraw.github.io

MIT License

223 stars 57 forks source link

Add chart image to readme #72

Closed harlantwood closed 7 months ago

harlantwood commented 8 months ago

Same idea as outlined in https://github.com/AstroDraw/AstroChart/issues/70 -- to immediately give the user the visual idea of what is possible.

You can see the rendered version of the README with image here: https://github.com/harlantwood/AstroChart/tree/patch-1?tab=readme-ov-file#astrochart

afucher commented 8 months ago

Hey @harlantwood , From where this image is? https://github.com/AstroDraw/AstroChart/assets/38769/0adc6822-7145-4e33-9e0b-53065e96d61a Sorry, if I'm missing something, but I did not found where this image is.

harlantwood commented 8 months ago

Hey @harlantwood , From where this image is? https://github.com/AstroDraw/AstroChart/assets/38769/0adc6822-7145-4e33-9e0b-53065e96d61a Sorry, if I'm missing something, but I did not found where this image is.

I made the PR via GitHub UI, uploaded the image in the UI, and GitHub gave it that URL… so, GitHub magic. ✨

afucher commented 8 months ago

I made the PR via GitHub UI, uploaded the image in the UI, and GitHub gave it that URL… so, GitHub magic. ✨

Hmmm... so I fhink that is better to upload the image to the repo in a folder and reference it in the README.

harlantwood commented 8 months ago

Added the image in a separate PR: #75.

We should merge that one first.

After that, the branch behind this PR will show the image correctly in its readme when clicking this link:

https://github.com/harlantwood/AstroChart/tree/patch-1#example

What you should see there will be something like: