Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
JHWelch committed Apr 12, 2024
1 parent e6b2734 commit b3b8763
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,49 @@
# games.wowellworld.com

Simple Vue app for linking to daily games in one place.

## Install

```bash
npm install
```

## Development

```bash
npm run dev
```

## Generate PWA Assets

This will generate all proper asset icons for the PWA. The source icon is located at `public/icon.svg`.

```bash
npm run generate-pwa-assets
```

## Build for Production

This site is automatically deployed to GitHub Pages using [GitHub Actions](./.github/workflows/deploy.yml).

It can be manually built to the `dist` directory using

```bash
npm run build
```

## Testing

```bash
npm run test
```

## Linting & Fixing

```sh
npm run lint
```

```sh
npm run fix
```

0 comments on commit b3b8763

Please sign in to comment.