feat: add readme for architecture

Co-Authored-By: Tyler Ang-Wanek <tylerw@axosoft.com>
actions · Sep 3, 2020 · 0635b31 · 0635b31
1 parent 59e61b8
commit 0635b31
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -74,6 +74,28 @@ jobs:
       - run: npm test
 ```
 
+Architecture:
+The architecture can be selected using `node-arch`. Values are `x86`, `x64`, `arm64`, `armv6l`, `armv7l`, `ppc64le`, `s390x` (not all of the architectures are available on all platforms).
+```yaml
+jobs:
+  build:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        node: [ '10', '12' ]
+        arch: ['x86', 'x64']
+    name: Node ${{ matrix.node }} on ${{ matrix.arch }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+          node-arch: ${{ matrix.arch }}
+      - run: npm install
+      - run: npm test
+```
+
 Publish to npmjs and GPR with npm:
 ```yaml
 steps: