diff --git a/README.md b/README.md index 1104847..c5f2308 100644 --- a/README.md +++ b/README.md @@ -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', // - labelColor: 'ADF' // or (default 555) + labelColor: 'ADF' // or (default: '555') status: 'v1.2.3', // , required - color: 'blue', // or (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', // or (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) }) ```