Add a README.md

orf · Apr 26, 2020 · 1873074 · 1873074
1 parent 1a82326
commit 1873074
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+# Cargo Bloat Action Example ![bloat](https://github.com/orf/cargo-bloat-example/workflows/bloat/badge.svg) ![CI](https://github.com/orf/cargo-bloat-example/workflows/CI/badge.svg)
+
+This repository shows an example Rust project integrated with [Cargo Bloat Action](https://github.com/orf/cargo-bloat-action).
+
+You can see an example merge request here: https://github.com/orf/cargo-bloat-example/pull/1.
+
+The actual Github Actions file can be found [under `.github/workloads/bloat.yml`](./.github/workflows/bloat.yml).
+
+If you wish, feel free to make a pull request to this repository to experiment.