Skip to content

Commit

Permalink
docs: update readme (#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
miketheman authored Nov 1, 2024
1 parent e8d4443 commit 7cb0fe9
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A tool for finding security issues in GitHub Actions CI/CD setups.
> [!IMPORTANT]
> `zizmor` is currently in beta. You will encounter bugs; please file them!
![](./docs/assets/zizmor-demo.gif)
![zizmor demo](./docs/assets/zizmor-demo.gif)

See [`zizmor`'s documentation](https://woodruffw.github.io/zizmor/)
for [installation steps], as well as a [quickstart] and
Expand All @@ -20,6 +20,10 @@ for [installation steps], as well as a [quickstart] and

[detailed usage recipes]: https://woodruffw.github.io/zizmor/usage/

## License

`zizmor` is licensed under the [MIT License](./LICENSE).

## Contributing

See [our contributing guide!](./CONTRIBUTING.md)
Expand All @@ -30,4 +34,12 @@ See [our contributing guide!](./CONTRIBUTING.md)

[Now you can have beautiful clean workflows!]: https://www.youtube.com/watch?v=ol7rxFCvpy8

[roadmap]: https://github.com/woodruffw/zizmor/issues/1
## Star History

<a href="https://star-history.com/#woodruffw/zizmor&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=woodruffw/zizmor&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=woodruffw/zizmor&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=woodruffw/zizmor&type=Date" />
</picture>
</a>

0 comments on commit 7cb0fe9

Please sign in to comment.