Browse Source

update README.md

SakiKawasaki 5 years ago
parent
commit
a6c07e16e7
2 changed files with 16 additions and 1 deletions
  1. 15 0
      README.md
  2. 1 1
      badgemaker/badgemaker.nim

+ 15 - 0
README.md

@@ -6,6 +6,21 @@ The Nim badgemaker tool.
 -   via git: `nimble install https://github.com/Ethosa/badgemaker`
 
 
+## Standart badge params
+-   `style` -- "flat".
+-   `label` -- "".
+-   `value` -- "".
+-   `label_text_color` -- "white".
+-   `value_text_color` -- "black".
+-   `label_color` -- "#212121".
+-   `value_color` -- "#e0e0e0".
+-   `font` -- "DejaVu Sans,Verdana,Geneva,sans-serif".
+-   `font_size` -- 12.
+-   `width` -- 120.
+-   `height` -- 20.
+-   `image_path` -- "".
+-   `image_color` -- "".
+
 ## Results
 [![test1](https://github.com/Ethosa/badgemaker/blob/master/tests/test1.svg)](https://github.com/Ethosa/badgemaker/blob/master/tests/test1.svg)  
 [![test2](https://github.com/Ethosa/badgemaker/blob/master/tests/test2.svg)](https://github.com/Ethosa/badgemaker/blob/master/tests/test2.svg)  

+ 1 - 1
badgemaker/badgemaker.nim

@@ -7,7 +7,7 @@ from base64 import encode
 
 type
   BadgeRef* = ref object
-    style: string  ## egg "flat", "square" or "plastic"
+    style: string  ## egg "flat", "square", "plastic" etc.
     label: string  ## left text.
     value: string  ## right text.
     label_text_color: string  ## left text color