Skip to content

Commit

Permalink
📝 Added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EdTonatto committed Jun 19, 2023
1 parent 11b5dc7 commit 064e602
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
# game-notes
# Game Notes

Game Notes is a private project for taking notes on games. It uses React with Phosphor icons and Vite as a build tool.

## Installation

To install dependencies, run:

```bash
npm install
```

## Usage

To start the development server, run:

```bash
npm run dev
```

To create a production build, run:

```bash
npm run build
```

To deploy to Github pages, run:

```bash
npm run deploy
```

## Dependencies

- phosphor-react: ^1.4.1
- react: ^18.2.0
- react-dom: ^18.2.0

## License

This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).

0 comments on commit 064e602

Please sign in to comment.