Specify fill="none" for transparency in SVG

[logo.git] / README.md

diff --git a/README.md b/README.md
index b010211bdebbd6c9c18411290d0bd95474db2ba3..73bbf00663de155b0e426f1e8ad947f5e285570c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,20 +1,30 @@
 # personal logo
 A simple logo I designed for myself
 
-<img src="png/256/color-dark.png" style="max-width: 50%; height: auto">
+<img src="logo.webp" style="width: 250px; max-width: 100%; height: auto">
+
+## Generation
+Running `svg2img <format>` will generate all the variants of the logo in SVG, PNG, and the format 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.
+
+### 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
+Copyright 2021 Armaan Bhojwani. `svg2img` is MIT Licensed, however the logo itself is [not licensed](https://choosealicense.com/no-permission/), and under exclusive copyright.