Update README

[logo.git] / README.md

diff --git a/README.md b/README.md
index ef2ef8b18cd0b93d5608e1da1ef708123289a172..6248f7c8aa883212ad80ee2ebade834f1a192a24 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,20 +1,32 @@
 # personal logo
-A logo I designed for myself
+A logo/icon/pfp I designed for myself
 
-## Criteria
-  * Looks equally good in ASCII art
-  * Easily vectorized
-  * Not too much detail
-  * Represents me somehow
+![Logo](logo-square-color-dark-256.png)
 
-## Uses
-  * Website
-  * Business card (both [curl](https://armaan.bhojwani.org/card) and paper)
-  * Neofetch picture
-  * Profile picture
-  * Git repo READMEs
-  * Anywhere that I put my name
+## 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
+  * Written as a simple SVG
+  * Looks equally good in ASCII/Unicode art
+  * Monochrome
+  * No words/typefaces involved
+
+## Color palette
+| color       | hex     |
+|-------------|---------|
+| white       | #000000 |
+| dark        | #212121 |
+| color       | #00FFBF |
+| transparent | n/a     |
 
 ## License
-WTFPLv2, see COPYING for more information
-Armaan Bhojwani 2020
+Copyright 2021 Armaan Bhojwani. `svg2img` is MIT Licensed, however the logo itself is [not licensed](https://choosealicense.com/no-permission/), and under exclusive copyright.