docs: add SimpleSecureReq usage examples and API reference to README
#51
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check building and linting | |
| on: | |
| push: | |
| branches: [ "**" ] | |
| pull_request: | |
| # The branches below must be a subset of the branches above | |
| branches: [ "**" ] | |
| jobs: | |
| build: | |
| name: Run build | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: read | |
| steps: | |
| - name: Set up NodeJS | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: 'lts/*' | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Install dependencies | |
| run: npm i | |
| - name: Run build | |
| run: npm run build | |
| eslint: | |
| name: Run ESLint | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: read | |
| steps: | |
| - name: Set up NodeJS | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: 'lts/*' | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Install dependencies | |
| run: npm i | |
| - name: Run ESLint | |
| run: npm run lint | |
| ava: | |
| name: Run AVA tests | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: read | |
| steps: | |
| - name: Set up NodeJS | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: 'lts/*' | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Install dependencies | |
| run: npm i | |
| - name: Run AVA tests | |
| run: npm run test |