diff --git a/README.md b/README.md new file mode 100644 index 0000000..311e827 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +
+ +# :boom: Obliterate-Repository + +~Want to leave town **leaving nothing behind**?~ + +Well this is just the **action** for you! + +
+ +# + +--- + +# Usage + +See [action.yml](./action.yml) for more details. + +Add this to your `Actions`: + +```yaml +- uses: JumperBot/Obliterate-Repository@v1 + with: + branch: "dev-branch" # defaults to master + message: ":boom: End Game Commit" # defaults to :boom: Obliterated! +``` + +#License + +This is licensed under the [MIT LICENSE](./LICENSE)