Skip to content

Commit b5c1211

Browse files
committed
📃 docs: update docs
1 parent 08d9319 commit b5c1211

File tree

3 files changed

+41
-67
lines changed

3 files changed

+41
-67
lines changed

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Braian Diez
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 17 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,26 @@
1-
# Nuxt 3 Minimal Starter
1+
# [Palette Pilot](https://palette-pilot.vercel.app/)
22

3-
Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
3+
Palette Pilot is an open source project built with Nuxt.js that helps you extract the most relevant colors from an image. With Palette Pilot, you can easily drop or upload an image and instantly discover the five most prominent colors within it.
44

5-
## Setup
5+
## Features
66

7-
Make sure to install the dependencies:
7+
- Extract the 5 most relevant colors from an image
8+
- Compare colors to check their contrast ratios
9+
- Visualize color combinations with UI elements examples
810

9-
```bash
10-
# npm
11-
npm install
11+
## Why Palette Pilot?
1212

13-
# pnpm
14-
pnpm install
13+
- Simplicity: Palette Pilot offers a user-friendly interface that makes it easy to extract colors and compare them.
14+
- Efficiency: Save time by quickly identifying the most relevant colors within an image.
15+
- Design-friendly: Whether you're a designer, developer, or enthusiast, Palette Pilot helps you pick colors that work harmoniously together.
1516

16-
# yarn
17-
yarn install
17+
## Run locally
1818

19-
# bun
20-
bun install
21-
```
19+
- Clone the repository: `git clone https://github.com/your-username/palette-pilot.git`
20+
- Navigate to the project directory: `cd palette-pilot`
21+
- Install dependencies: `bun install`
22+
- Start the development server: `bun run dev`
2223

23-
## Development Server
24+
## License
2425

25-
Start the development server on `http://localhost:3000`:
26-
27-
```bash
28-
# npm
29-
npm run dev
30-
31-
# pnpm
32-
pnpm run dev
33-
34-
# yarn
35-
yarn dev
36-
37-
# bun
38-
bun run dev
39-
```
40-
41-
## Production
42-
43-
Build the application for production:
44-
45-
```bash
46-
# npm
47-
npm run build
48-
49-
# pnpm
50-
pnpm run build
51-
52-
# yarn
53-
yarn build
54-
55-
# bun
56-
bun run build
57-
```
58-
59-
Locally preview production build:
60-
61-
```bash
62-
# npm
63-
npm run preview
64-
65-
# pnpm
66-
pnpm run preview
67-
68-
# yarn
69-
yarn preview
70-
71-
# bun
72-
bun run preview
73-
```
74-
75-
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
26+
Palette Pilot is released under the MIT License.

‎package.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"name": "nuxt-app",
2+
"name": "palette-pilot",
33
"private": true,
44
"type": "module",
5+
"author": "Braian Diez",
6+
"license": "MIT",
57
"scripts": {
68
"build": "nuxt build",
79
"dev": "nuxt dev",

0 commit comments

Comments
 (0)