auto-commit-msg icon indicating copy to clipboard operation
auto-commit-msg copied to clipboard

Update docs

Open MichaelCurrin opened this issue 5 years ago • 6 comments

Add badges

Add sample image

MichaelCurrin avatar Aug 10 '20 21:08 MichaelCurrin

Add download button for latest release

MichaelCurrin avatar Aug 10 '20 21:08 MichaelCurrin

Also the main README.md needs to look and be appealing in the extension view in VS Code (so it needs to keep some light instructions, screenshots/gifs and links to the docs).

Is it possible to package the extension with an alternate doc file other than README? It will only be on file still.

MichaelCurrin avatar Aug 13 '20 18:08 MichaelCurrin

Some links may break - image links or click links. When viewing in VS Code vs github.

This is easily to check though when I install my extension and view it in the extensions pane, without publishing yet.

MichaelCurrin avatar May 12 '21 07:05 MichaelCurrin

Oh it looks like the a local reference to the image actually gets updated at build time to point to GitHub. I changed the logo and rebuilt. The logo in README.md still references the old one on GH.

MichaelCurrin avatar May 12 '21 08:05 MichaelCurrin

Even though the extension icon is up to date

MichaelCurrin avatar May 12 '21 08:05 MichaelCurrin

Also links go to

https://github.com/MichaelCurrin/auto-commit-msg/blob/HEAD/docs/README.md

and then get a git reference in the branch name

MichaelCurrin avatar May 12 '21 08:05 MichaelCurrin