Skip to content

Commit

Permalink
docs(readme): add a GIF to demonstrate the tool
Browse files Browse the repository at this point in the history
  • Loading branch information
engineervix committed Jul 9, 2021
1 parent 42bffb4 commit 82afdbe
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Expand Up @@ -44,6 +44,11 @@

> Generates a coverage badge using coverage.py and the shields.io service. Your README file is then updated with the generated badge.
<p align="center">
<img src="https://github.com/engineervix/readme-coverage-badger/blob/assets/demo.gif" alt="demo.gif">
</p>
<!-- ![demo.gif](../assets/demo.gif?raw=true) -->

**Source Code**: [github.com/engineervix/readme-coverage-badger](https://github.com/engineervix/readme-coverage-badger)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -204,7 +209,7 @@ Please give a ⭐️ if this project helped you!

### docs

- [ ] Add a screenshot / demo in this README
- [X] Add a screenshot / demo in this README
- [ ] Create standalone documentation for hosting either on Github Pages or readthedocs. This README is already detailed enough to serve as documentation!

### other
Expand Down

0 comments on commit 82afdbe

Please sign in to comment.