feat(action): step summary (#6)

* feat(action): step summary (#2)

* docs(readme): update

* docs: revert header

The edit link is already present on the same page
as the README.

* docs: explain gh step summaries

Co-authored-by: Oliver Nordbjerg <[email protected]>

.github/workflows/nodejs.yml

@@ -0,0 +1,32 @@
+name: nodejs
+
+on: 
+  push:
+     paths:
+      - "**/**"
+      - "!**/*.md/**"
+jobs:
+  pipeline:
+    name: Node ${{ matrix.node-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: ['16.x']
+        os: ['ubuntu-latest']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+        id: install
+
+      - name: Build project
+        run: npm run build
+        id: production

README.md

@@ -1,6 +1,6 @@
 ## `foundry-toolchain` Action
 
-This GitHub action installs [Foundry](https://github.com/foundry-rs/foundry).
+This GitHub Action installs [Foundry](https://github.com/foundry-rs/foundry).
 
 ### Example workflow
 
@@ -25,10 +25,27 @@ jobs:
 
       - name: Run tests
         run: forge test -vvv
+
+      - name: Run snapshot
+        run: forge snapshot
 ```
 
 ### Inputs
 
 | **Name**  | **Required** | **Description**                                                                                               | **Type** |
 |-----------|--------------|---------------------------------------------------------------------------------------------------------------|----------|
 | `version` | Yes          | Version to install, e.g. `nightly` or `1.0.0`.  **Note:** Foundry only has nightly builds for the time being. | string   |
+
+
+### Summaries
+
+You can add the output of Forge and Cast commands to GitHub step summaries. The summaries support GitHub flavored Markdown.
+
+For example, to add the output of `forge snapshot` to a summary, you would change the snapshot step to:
+
+```yml
+- name: Run snapshot
+  run: forge snapshot >> $GITHUB_STEP_SUMMARY
+```
+
+See the offical [GitHub docs](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary) for more information.