Skip to content

Commit 172b801

Browse files
committed
fix: Update readme.md
1 parent fc6c20c commit 172b801

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# CoCreate-api
22

3-
A simple api helper component in vanilla javascript used by JavaScript developers to create thirdparty api intergrations. Thirdparty apis can be accessible using HTML5 data-attributes and/or JavaScript API. Take it for a spin in our [playground!](https://cocreate.app/docs/api)
3+
A simple api helper component in vanilla javascript used by JavaScript developers to create thirdparty api intergrations. CoCreate-api includes the client component and server side for api processing. Thirdparty apis can be accessible using HTML5 data-attributes and/or JavaScript API. Take it for a spin in our [playground!](https://cocreate.app/docs/api)
44

5-
![GitHub file size in bytes](https://img.shields.io/github/size/CoCreate-app/CoCreate-api/dist/CoCreate-api.min.js?label=minified%20size&style=for-the-badge)
6-
![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-api?style=for-the-badge)
7-
![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-api?style=for-the-badge)
8-
![GitHub labels](https://img.shields.io/github/labels/CoCreate-app/CoCreate-api/help%20wanted?style=for-the-badge)
5+
![minified](https://img.badgesize.io/https://cdn.cocreate.app/api/latest/CoCreate-api.min.js?style=flat-square&label=minified&color=orange)
6+
![gzip](https://img.badgesize.io/https://cdn.cocreate.app/api/latest/CoCreate-api.min.js?compression=gzip&style=flat-square&label=gzip&color=yellow)
7+
![brotli](https://img.badgesize.io/https://cdn.cocreate.app/api/latest/CoCreate-api.min.js?compression=brotli&style=flat-square&label=brotli)
8+
![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-api?style=flat-square)
9+
![License](https://img.shields.io/github/license/CoCreate-app/CoCreate-api?style=flat-square)
10+
![Hiring](https://img.shields.io/static/v1?style=flat-square&label=&message=Hiring&color=blueviolet)
911

1012
![CoCreate-api](https://cdn.cocreate.app/docs/CoCreate-api.gif)
1113

@@ -29,6 +31,12 @@ For a complete guide and working demo refer to the [doumentation](https://cocrea
2931
$ npm i @cocreate/api
3032
```
3133

34+
## yarn
35+
36+
```shell
37+
$ yarn install @cocreate/api
38+
```
39+
3240
# Table of Contents
3341

3442
- [Table of Contents](#table-of-contents)
@@ -72,4 +80,4 @@ We appreciate your continued support, thank you!
7280

7381
# License
7482

75-
[Server Side Public License (SSPL)](https://github.com/CoCreate-app/CoCreate-api/blob/master/LICENSE)
83+
[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-api/blob/master/LICENSE)

0 commit comments

Comments
 (0)