Skip to content

Commit

Permalink
Add Lyo πŸŽ‰ github.com/bokub/lyo
Browse files Browse the repository at this point in the history
  • Loading branch information
bokub committed Aug 31, 2018
1 parent 0f1c7b4 commit feccd26
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 19 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
*.log
node_modules/
package-lock.json
dist

.nyc_output
coverage.lcov
Expand Down
42 changes: 25 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# gradient-badges

[![npm][version]](https://www.npmjs.com/package/gradient-badges)
[![Demo][demo-src]][demo]
[![XO code style][xo]](https://github.com/sindresorhus/xo)
[![License][license]](https://github.com/bokub/gradient-badges/blob/master/LICENSE)
[![npm](https://runkit.io/bokub/gb-v/branches/master)](https://www.npmjs.com/package/gradient-badges)
[![Demo](https://runkit.io/bokub/badge/branches/master/demo/available/11998e-38ef7d)](https://git.io/gradient-badges)
[![XO code style](https://runkit.io/bokub/badge/branches/master/style/XO/ff94c8-cacfda-61eddb)](https://github.com/sindresorhus/xo)
[![License](https://runkit.io/bokub/badge/branches/master/license/MIT/ff426b-ffbc36)](https://github.com/bokub/gradient-badges/blob/master/LICENSE)

> 🍭 Badge generator with gradient support
> Badge generator with gradient support
#### Check out the [demo][demo] to make your own badge

Expand All @@ -19,6 +19,8 @@ $ npm i gradient-badges

**gradient-badges** works exactly like [badgen](https://github.com/amio/badgen), with the **`gradient`** parameter in addition.

**Node.js**

```javascript
const badges = require('gradient-badges')

Expand All @@ -30,6 +32,17 @@ const svgString = badges({
})
```

**Browser**
```html
<script src="https://cdn.jsdelivr.net/npm/gradient-badges@latest/dist/gradient-badges.min.js"></script>

<script>
var svgString = gradientBadges({
// Same options as above
});
</script>
```

Result: ![Result][usage]

## Examples
Expand All @@ -55,18 +68,13 @@ Here are a few examples of what you can do.

- [badgen](https://github.com/amio/badgen) - Fast handcraft svg badge generator.

[version]: https://runkit.io/bokub/gb-v/branches/master
[demo-src]: https://gradient-badges.now.sh/demo/available/11998e-38ef7d
[xo]: https://gradient-badges.now.sh/style/XO/ff94c8-cacfda-61eddb
[license]: https://gradient-badges.now.sh/license/MIT/ff426b-ffbc36

[usage]: https://gradient-badges.now.sh/version/v1.2.3/pink-F78642?style=flat
[usage]: https://runkit.io/bokub/badge/branches/master/version/v1.2.3/pink-F78642?style=flat

[demo]: https://git.io/gradient-badges

[stars]: https://gradient-badges.now.sh/stars/β˜…β˜…β˜…β˜…β˜†/00a65e-abf269
[standard]: https://gradient-badges.now.sh/code%20style/standard/ff22aa-bf00ff?style=flat
[patreon]: https://gradient-badges.now.sh/become/a%20patron/f96854-f9be75
[instagram]: https://gradient-badges.now.sh/follow%20me/instagram/833ab4-fd1d1d-fcb045
[vue]: https://gradient-badges.now.sh/built%20with/Vue.js/42b883-35495e?style=flat
[rainbow]: https://gradient-badges.now.sh/rainbow/compatible/00a3e2-1ba548-fdc800-f1860e-e41b13
[stars]: https://runkit.io/bokub/badge/branches/master/stars/β˜…β˜…β˜…β˜…β˜†/00a65e-abf269
[standard]: https://runkit.io/bokub/badge/branches/master/code%20style/standard/ff22aa-bf00ff?style=flat
[patreon]: https://runkit.io/bokub/badge/branches/master/become/a%20patron/f96854-f9be75
[instagram]: https://runkit.io/bokub/badge/branches/master/follow%20me/instagram/833ab4-fd1d1d-fcb045
[vue]: https://runkit.io/bokub/badge/branches/master/built%20with/Vue.js/42b883-35495e?style=flat
[rainbow]: https://runkit.io/bokub/badge/branches/master/rainbow/compatible/00a3e2-1ba548-fdc800-f1860e-e41b13
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "gradient-badges",
"version": "1.0.1",
"version": "1.1.0",
"author": "Boris K",
"dependencies": {
"badgen": "^2.x"
Expand All @@ -9,11 +9,13 @@
"ava": "^0.25.0",
"codecov": "^3.0.4",
"is-svg": "^3.0.0",
"lyo": "latest",
"nyc": "^13.0.1",
"xo": "^0.22.0"
},
"files": [
"index.js"
"index.js",
"dist/gradient-badges.min.js"
],
"homepage": "https://github.com/bokub/gradient-badges",
"keywords": [
Expand All @@ -33,6 +35,7 @@
"main": "index.js",
"scripts": {
"coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
"prepublishOnly": "lyo",
"test": "xo && nyc ava -v"
}
}

0 comments on commit feccd26

Please sign in to comment.