Skip to content

Commit 47edc74

Browse files
committed
add instatll instructions, media example
1 parent c01282c commit 47edc74

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
11
# CoCreate-attributes
2-
A simple HTML5 and pure javascript component. Easy configuration using data-attributes and highly styleable.
32

4-
![GitHub file size in bytes](https://img.shields.io/github/size/CoCreate-app/CoCreate-attributes/dist/CoCreate-attributes.min.js?label=minified%20size&style=for-the-badge)
3+
A simple attributes 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/attributes)
4+
5+
![GitHub file size in bytes](https://img.shields.io/github/size/CoCreate-app/CoCreate-attributes/dist/CoCreate-attributes.min.js?label=minified%20size&style=for-the-badge)
56
![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-attributes?style=for-the-badge)
6-
![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-attributes?style=for-the-badge)
7+
![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-attributes?style=for-the-badge)
78
![GitHub labels](https://img.shields.io/github/labels/CoCreate-app/CoCreate-attributes/help%20wanted?style=for-the-badge)
89

910
![CoCreate-attributes](https://cdn.cocreate.app/docs/CoCreate-attributes.gif)
1011

11-
## [Docs & Demo](https://cocreate.app/docs/attributes)
12-
12+
## [Docs & Demo](https://cocreate.app/docs/clone)
1313

1414
For a complete guide and working demo refer to the [doumentation](https://cocreate.app/docs/attributes)
1515

1616
## CDN
17+
1718
```html
1819
<script src="https://cdn.cocreate.app/attributes/latest/CoCreate-attributes.min.js"></script>
1920
```
21+
2022
```html
2123
<script src="https://cdn.cocreate.app/attributes/latest/CoCreate-attributes.min.css"></script>
2224
```
2325

2426
## NPM
27+
2528
```shell
2629
$ npm install @cocreate/attributes
2730
```
@@ -36,17 +39,19 @@ $ npm install @cocreate/attributes
3639
- [License](#license)
3740

3841
<a name="announcements"></a>
42+
3943
# Announcements
4044

41-
All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-attributes/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-attributes/releases). You may also subscribe to email for releases and breaking changes.
45+
All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-attributes/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-attributes/releases). You may also subscribe to email for releases and breaking changes.
4246

4347
<a name="roadmap"></a>
48+
4449
# Roadmap
4550

4651
If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreate-app/CoCreate-attributes/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-attributes/pulls). We would love to hear your feedback.
4752

48-
4953
<a name="about"></a>
54+
5055
# About
5156

5257
CoCreate-attributes is guided and supported by the CoCreate Developer Experience Team.
@@ -56,6 +61,7 @@ Please Email the Developer Experience Team [here](mailto:develop@cocreate.app) i
5661
CoCreate-attributes is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
5762

5863
<a name="contribute"></a>
64+
5965
# How to Contribute
6066

6167
We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreate-attributes/blob/master/CONTRIBUTING.md) guide for details.
@@ -65,4 +71,5 @@ We want this library to be community-driven, and CoCreate led. We need your help
6571
We appreciate your continued support, thank you!
6672

6773
# License
68-
[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-attributes/blob/master/LICENSE)
74+
75+
[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-attributes/blob/master/LICENSE)

0 commit comments

Comments
 (0)