docs: update docs for `scale`

pull/61/head
amio 2019-10-03 12:31:08 +08:00
rodzic a8fcb2f5f4
commit c81a539a2b
1 zmienionych plików z 7 dodań i 6 usunięć

Wyświetl plik

@ -9,7 +9,7 @@ Fast handcraft svg badge generator. Used on [badgen.net](https://badgen.net).
- 🌀 Zero dependency
- ⚡️ Fast by design (see [benchmarks](#benchmarks))
- 👯‍ Pure JavaScript, running in node & browser
- 👯‍ Running in node & browser
## Usage
@ -21,12 +21,13 @@ const badgen = require('badgen')
// only `status` is required.
const svgString = badgen({
label: 'npm', // <Text>
labelColor: 'ADF' // <Color RGB> or <Color Name> (default 555)
labelColor: 'ADF' // <Color RGB> or <Color Name> (default: '555')
status: 'v1.2.3', // <Text>, required
color: 'blue', // <Color RGB> or <Color Name> (default blue)
style: 'flat', // 'flat' or undefined
icon: 'data:image/svg+xml;base64,...', // Use icon
iconWidth: 13, // Set this if icon is not square
color: 'blue', // <Color RGB> or <Color Name> (default: 'blue')
style: 'flat', // 'flat' or 'classic' (default: 'classic')
icon: 'data:image/svg+xml;base64,...', // Use icon (default: undefined)
iconWidth: 13, // Set this if icon is not square (default: 13)
scale: 1 // Set badge scale (default: 1)
})
```