caracals-badge/README.md

29 lines
449 B
Markdown
Raw Normal View History

2021-03-17 11:40:44 +00:00
Inspired by: [github-fork-ribbon-css](https://github.com/simonwhitaker/github-fork-ribbon-css)
Using [Webpack](https://webpack.js.org/)
2021-03-17 11:40:44 +00:00
Install
=======
2021-03-17 18:55:42 +00:00
2021-03-17 11:40:44 +00:00
npm install .
Build
=====
npm run prod
2021-03-17 11:40:44 +00:00
2021-12-16 18:51:43 +00:00
The JS bundle is then located in `dist/` folder.
2021-03-17 11:40:44 +00:00
2021-03-17 18:55:42 +00:00
Usage
=====
Just add (orientation can be `left-bottom`, `right-bottom`, `right-top` or `left-top`):
2021-03-17 18:55:42 +00:00
```html
<script src="path/to/caracals-badge.js" orientation="left-bottom"></script>
```
2021-03-17 18:55:42 +00:00