Skip to content

Commit

Permalink
Document usage in README
Browse files Browse the repository at this point in the history
  • Loading branch information
cs278 committed Jan 26, 2023
1 parent 3a0fb99 commit 09e78ce
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Composer Rich Diff Action
=========================

This is a GitHub Action which runs against a pull request and generates a comment
documenting the changes to Composer dependencies that are included in the pull
request.

Usage
-----

```yaml
name: Composer Rich Diff

on:
pull_request:

permissions:
contents: read
pull-requests: write

jobs:
diff:
name: Generate Diff
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: cs278/composer-rich-diff-action@v1
with:
path: ./composer.json
```

0 comments on commit 09e78ce

Please sign in to comment.