diff --git a/README.md b/README.md index 738ce70..46fe8aa 100644 --- a/README.md +++ b/README.md @@ -1 +1,38 @@ # imgcat + +Display a remote image into the terminal. + +## Build + +Install Go Lang from: https://go.dev/ + +Then build + +With make +``` +make +``` + +Or directly +``` +go build -o imgcat +``` + +## Usage + +``` +./imgcat -url "https://images.pexels.com/photos/2558605/pexels-photo-2558605.jpeg?cs=srgb&dl=pexels-anel-rossouw-2558605.jpg&fm=jpg" -height 25 +``` + +Capture d’écran 2021-12-11 à 17 40 55 + +## Help + +``` +# imgcat -h +Usage of imgcat: + -height int + maximum height in lines + -url string + url of the jpg +```