Skip to content

Commit

Permalink
fix: update readme and description meta
Browse files Browse the repository at this point in the history
  • Loading branch information
tonycassara committed Dec 1, 2023
1 parent a100983 commit c98d649
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 27 deletions.
31 changes: 5 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,9 @@
# React + TypeScript + Vite
# 🖥️ Monitor Light Box

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
## Use your monitor as a light source for videography and photography

Currently, two official plugins are available:
**Note:** Works best if you have Night Shift disabled.

- [@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
Take advantage of your existing light sources including computer monitors, TVs, and handheld devices. This dead simple web app makes it easy to add another light source from any of your internet connected devices. Just visit https://tonycassara.github.io/monitor-light-box and start shining!

## 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
Special thank you to Andreas Siess for sharing his Kelvin to RGB dictionary: https://andi-siess.de/rgb-to-color-temperature/
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta property="og:type" content="website" />
<meta
property="og:description"
content="Use your monitor as a light source for videography and photography. Dial in the perfect shade using Kelvin temperature units!"
content="Take advantage of your existing light sources including computer monitors, TVs, and handheld devices. This dead simple web app makes it easy to add another light source from any of your internet connected devices. Just choose your desired temperature in Kevlin and start shining!"
/>
<meta
property="og:image"
Expand Down

0 comments on commit c98d649

Please sign in to comment.