Skip to content

Commit 92b11c9

Browse files
committed
docs: update README to provide a clearer description of the conotes app and its technology stack
1 parent a0e7fc2 commit 92b11c9

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
# React + Vite
1+
# conotes
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
conotes is a mobile-first Cornell Notes web app. It helps you structure notes, keep them in local storage, and export them as Markdown or PDF.
44

5-
Currently, two official plugins are available:
5+
## Tech
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7+
- React + Vite
8+
- Tailwind CSS
99

10-
## React Compiler
10+
## Run locally
1111

12-
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
12+
1. npm install
13+
2. npm run dev
1314

14-
## Expanding the ESLint configuration
15+
## Build
1516

16-
If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
17+
1. npm run build
18+
19+
## Deploy
20+
21+
GitHub Pages deployment is configured via GitHub Actions on push to main.

0 commit comments

Comments
 (0)