diff --git a/README.md b/README.md index e501de6..5ae7a1c 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,30 @@ A Github Action for creating Github Releases +## Usage + +```yaml +name: Main + +on: push + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@master + with: + fetch-depth: 1 + - name: Build + run: echo ${{ github.sha }} > Release.txt + - name: Release + uses: docker://softprops/action-gh-release + if: ${{ startsWith(github.ref, 'refs/tags/') }} + with: + files: Release.txt + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +``` + Doug Tangren (softprops) 2019 \ No newline at end of file