Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasQuan committed Aug 8, 2024
1 parent 93e59c8 commit 76ffccf
Showing 1 changed file with 10 additions and 42 deletions.
52 changes: 10 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,14 @@
# Getting Started with Create React App
# Color Theory Master Panel

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
This project was inspired by the collection of color theory resources I have been collecting over the years. From accessbility to color harmonies, this project aims to provide a one-stop-shop for all things color theory when picking colors for your next project.

## Available Scripts
## Build With
- React
- Tailwind
- Bun
- Vite
- Typescript

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).
#### Credits
Design inspired by @HunorMarton [HSL Color Picker](https://codepen.io/HunorMarton/pen/dvXVvQ/)

0 comments on commit 76ffccf

Please sign in to comment.