docs(readme): add more props that the component accepts (#3) #16
This file contains 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: CI | |
on: | |
push: | |
branches: main | |
pull_request: {} | |
jobs: | |
biome: | |
name: ◭ Biome | |
runs-on: ubuntu-latest | |
steps: | |
- name: ⬇️ Checkout repo | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: ⎔ Setup node | |
uses: actions/setup-node@v4 | |
with: | |
node-version: '20.x' | |
- name: 🧅 Setup bun | |
uses: oven-sh/setup-bun@v1 | |
- name: ◭ Setup Biome | |
uses: biomejs/setup-biome@v2 | |
- name: 📥 Download deps | |
run: bun install | |
- name: 🔬 Lint | |
run: biome ci . | |
typecheck: | |
name: ʦ TypeScript | |
runs-on: ubuntu-latest | |
steps: | |
- name: ⬇️ Checkout repo | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: ⎔ Setup node | |
uses: actions/setup-node@v4 | |
with: | |
node-version: '20.x' | |
- name: 🧅 Setup bun | |
uses: oven-sh/setup-bun@v1 | |
- name: 📥 Download deps | |
run: bun install | |
- name: 🔎 Type check | |
run: bun run typecheck | |
vitest: | |
name: ⚡ Vitest | |
runs-on: ubuntu-latest | |
steps: | |
- name: ⬇️ Checkout repo | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: ⎔ Setup node | |
uses: actions/setup-node@v4 | |
with: | |
node-version: '20.x' | |
- name: 🧅 Setup bun | |
uses: oven-sh/setup-bun@v1 | |
- name: 📥 Download deps | |
run: bun install | |
- name: ⚡ Run vitest | |
run: bun run test:ci | |
build: | |
name: Build | |
runs-on: ubuntu-latest | |
steps: | |
- name: ⬇️ Checkout repo | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: ⎔ Setup node | |
uses: actions/setup-node@v4 | |
with: | |
node-version: '20.x' | |
- name: 🧅 Setup bun | |
uses: oven-sh/setup-bun@v1 | |
- name: 📥 Download deps | |
run: bun install | |
- name: 🏗️ Build package | |
run: bun run build |