diff --git a/README.md b/README.md index c563b212..e27f1ee3 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # CoCreate-docs -A simple docs component in vanilla javascript. Easily configured using HTML5 data-attributes and/or JavaScript API. Take it for a spin in our [playground!](https://cocreate.app/docs/docs) +Documentation generator Take it for a spin in our [playground!](https://cocreate.app/docs/docs) -![GitHub file size in bytes](https://img.shields.io/github/size/CoCreate-app/CoCreate-docs/dist/CoCreate-docs.min.js?label=minified%20size&style=for-the-badge) -![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-docs?style=for-the-badge) -![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-docs?style=for-the-badge) -![GitHub labels](https://img.shields.io/github/labels/CoCreate-app/CoCreate-docs/help%20wanted?style=for-the-badge) +![minified](https://img.badgesize.io/https://cdn.cocreate.app/docs/latest/CoCreate-docs.min.js?style=flat-square&label=minified&color=orange) +![gzip](https://img.badgesize.io/https://cdn.cocreate.app/docs/latest/CoCreate-docs.min.js?compression=gzip&style=flat-square&label=gzip&color=yellow) +![brotli](https://img.badgesize.io/https://cdn.cocreate.app/docs/latest/CoCreate-docs.min.js?compression=brotli&style=flat-square&label=brotli) +![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-docs?style=flat-square) +![License](https://img.shields.io/github/license/CoCreate-app/CoCreate-docs?style=flat-square) +![Hiring](https://img.shields.io/static/v1?style=flat-square&label=&message=Hiring&color=blueviolet) ![CoCreate-docs](https://cdn.cocreate.app/docs/CoCreate-docs.gif) @@ -29,6 +31,12 @@ For a complete guide and working demo refer to the [doumentation](https://cocrea $ npm i @cocreate/docs ``` +## yarn + +```shell +$ yarn install @cocreate/docs +``` + # Table of Contents - [Table of Contents](#table-of-contents)