feat(readme): update readme with usage and examples

ProfOak · Dec 8, 2018 · a1a1cb2 · a1a1cb2
1 parent c9d1fae
commit a1a1cb2
Show file tree

Hide file tree

Showing 14 changed files with 53 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,55 @@
 # gbprinter
 Convert images to GameBoy screenshots.
+
+Installation
+---
+
+```bash
+go get github.com/ProfOak/gbprinter
+```
+
+Usage
+---
+
+```bash
+gbprinter image.png
+```
+
+The resulting image will be named `image_color-palette.png`
+
+
+Extra
+---
+
+```bash
+gbprinter -help
+Usage of gbprinter:
+  -palette string
+          Color choices: down, downa, downb, grayscale, greenscale, left, lefta, leftb, right, righta, rightb, up, upa, upb (default "grayscale")
+```
+
+Examples
+---
+
+### Grayscales
+
+![original](images/amarao.jpg)
+![grayscale](images/amarao_grayscale.png)
+
+![original](images/catac.jpg)
+![grayscale](images/catac_grayscale.png)
+
+![original](images/integrating_pistol.jpg)
+![grayscale](images/integrating_pistol_grayscale.png)
+
+![original](images/kirby.png)
+![grayscale](images/kirby_grayscale.png)
+
+![original](images/wizard_cat.png)
+![grayscale](images/wizard_cat_grayscale.png)
+
+### Greenscale and the other color palettes
+
+![original](images/skate_or_die.jpg)
+![greenscale](images/skate_or_die_greenscale.png)
+![all of the color palettes](images/skate_or_die_collage.jpg)
diff --git a/images/amarao.jpg b/images/amarao.jpg
diff --git a/images/catac.jpg b/images/catac.jpg
diff --git a/images/integrating_pistol.jpg b/images/integrating_pistol.jpg
diff --git a/images/kirby.png b/images/kirby.png
diff --git a/images/pathetic.jpg b/images/pathetic.jpg
diff --git a/images/skate or die.jpg b/images/skate or die.jpg
diff --git a/images/skate or die_grayscale.png b/images/skate or die_grayscale.png
diff --git a/images/skate_or_die.jpg b/images/skate_or_die.jpg
diff --git a/images/skate or die_collage.jpg → images/skate_or_die_collage.jpg b/images/skate or die_collage.jpg → images/skate_or_die_collage.jpg
diff --git a/images/skate or die_greenscale.png → images/skate_or_die_greenscale.png b/images/skate or die_greenscale.png → images/skate_or_die_greenscale.png
diff --git a/images/wizard cat.png b/images/wizard cat.png
diff --git a/images/wizard_cat.png b/images/wizard_cat.png
diff --git a/images/wizard cat_grayscale.png → images/wizard_cat_grayscale.png b/images/wizard cat_grayscale.png → images/wizard_cat_grayscale.png