Update README

[logo.git] / README.md

diff --git a/README.md b/README.md
index 65428d662a8c8e45b9317ff8496dde3457ecc58e..6248f7c8aa883212ad80ee2ebade834f1a192a24 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,20 +1,32 @@
 # personal logo
-A simple logo I designed for myself
+A logo/icon/pfp I designed for myself
 
-<img src="png/256/color-dark.png" style="max-width: 50%; height: auto">
+![Logo](logo-square-color-dark-256.png)
+
+## Generation
+Running `svg2img <formats>` will generate all the variants of the logo in the formats of your choice. The logo goes from the template to SVG to PNG to whatever format you choose. It supports any format that ImageMagick supports, as well as ASCII and Unicode.
+
+For example, `svg2img webp heic` will generate SVG, PNG, WebP and HEIF versions of all 18 color and shape variants of the logo.
+
+### Depends
+  * Inkscape (core usage)
+  * ImageMagick (convert from PNG to anything)
+  * jp2a (convert from PNG to ASCII)
+  * chafa (convert from PNG to Unicode)
 
 ## Design Criteria
-  * Easily vectorized
+  * Written as a simple SVG
   * Looks equally good in ASCII/Unicode art
   * Monochrome
   * No words/typefaces involved
 
-## Color pallet
-| color | hex     |
-|-------|---------|
-| white | #000000 |
-| dark  | #212121 |
-| color | #00FFBF |
+## Color palette
+| color       | hex     |
+|-------------|---------|
+| white       | #000000 |
+| dark        | #212121 |
+| color       | #00FFBF |
+| transparent | n/a     |
 
 ## License
-Copyright 2021 Armaan Bhojwani. Creative Commons BY-NC-SA 4.0 license, see the LICENSE file for more information
+Copyright 2021 Armaan Bhojwani. `svg2img` is MIT Licensed, however the logo itself is [not licensed](https://choosealicense.com/no-permission/), and under exclusive copyright.