diff --git a/README.md b/README.md index e8ff1db..1b353d9 100644 --- a/README.md +++ b/README.md @@ -1 +1,20 @@ # palette-rip + +This small Haskell utility lets you extract dominant colours from a picture. + +## Dependencies + +You need [stack](https://docs.haskellstack.org/en/stable/) in order to build this project. + +## Installation and usage + + +Run +``` +stack build +``` + and then + ``` + stack run + ``` + to extract the *n* dominant colours from the specified picture. They will be displayed with their hex code inside of the terminal.