Skip to content

Commit

Permalink
fix: Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
frankpagan committed Jun 30, 2021
1 parent f357a32 commit 0abd507
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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)
Expand Down

0 comments on commit 0abd507

Please sign in to comment.