Skip to content

Commit

Permalink
chore: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
imp-dance committed Jan 15, 2024
1 parent 4c57a2b commit 0fa3656
Showing 1 changed file with 8 additions and 26 deletions.
34 changes: 8 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,12 @@
# React + TypeScript + Vite
# Hollow Knight Charm Builder

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
---

Currently, two official plugins are available:
This web-app lets you plan out charm-builds for Hollow Knight.

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
- Allows for _overcharming_ (try equipping a charm 3 times when you don't have sufficient notches)
- See charm synergies and build info
- Inspect charms easily with tooltips
- Responsive (but optimal on desktop)

## Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

- Configure the top-level `parserOptions` property like this:

```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
}
```

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
If you like this app, make sure you hit the **Star** button on the Github repo!

0 comments on commit 0fa3656

Please sign in to comment.