Skip to content

Commit 7615f9e

Browse files
Update README.md
1 parent 57f2995 commit 7615f9e

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

+33-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
11
# hue
2-
The open-sourced, parameter-based colour palette generator
2+
The open-sourced, parameter-based colour palette generator :rainbow:
3+
4+
## What ```hue``` is:
5+
- A tool that uses ```clustering``` as a method to extract the representative colours of an image, and hence form a palette
6+
- An app that uses the ```Unsplash API``` to scrape an image based on the parameters given
7+
- A hosted application that is under active development ( Check <i>Contributing</i> for more details on how to contribute to it
8+
9+
## What ```hue``` isn't (yet) :
10+
- A randomised palette generator; it needs keywords to search for, or an image provided by the user
11+
- A neural-network based system that generates palettes based on interpreted user preferences
12+
13+
## What ```hue``` uses:
14+
- Python
15+
- Scikit-Learn
16+
- Unsplash API
17+
- Flask
18+
- Bulma CSS
19+
20+
## Installation and Dependencies:
21+
- To install the required libraries, please open a ```virtual environment``` and run ```pip install -r requirements.txt```
22+
23+
## Contributing:
24+
Please feel free to contribute to ```hue```! :sparkles:
25+
- If you feel like a feature can be added/modified, please raise an <b>issue</b> in the ```Issues``` tab
26+
- If you are sending a PR, do mention the feature that you're improving, or the bug you're fixing or the new idea that you're adding
27+
- Any help is greatly appreciated :)
28+
29+
## Possible use cases for hue:
30+
- Image summarisation
31+
- Design Inspiration
32+
33+
## Version History:
34+
The current release is v1.0

0 commit comments

Comments
 (0)