Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zvecr committed Jul 15, 2024
1 parent 08623db commit 8a2a447
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,27 @@
# QMK Keyboard Browser

> Browse information on supported QMK keyboards
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/qmk/qmk_browser/build.yml?logo=github&style=for-the-badge)](https://github.com/qmk/qmk_browser/actions/workflows/build.yml?query=branch%3Amain)
[![Discord](https://img.shields.io/discord/440868230475677696.svg?logo=discord&logoColor=white&color=7289DA&style=for-the-badge)](https://discord.gg/Uq7gcHh)

Pages are automatically generated from keyboards currently in QMK. Default firmware files are up-to-date with the latest version of QMK.

## Development

### Project setup
```
yarn install
```

### Compiles and hot-reloads for development

```
yarn dev
```

### Build for production and serve files

```
yarn build && npx serve dist
```

0 comments on commit 8a2a447

Please sign in to comment.