Skip to content

Commit e4f41db

Browse files
committed
fix ream docs path from clone/
1 parent d02b6e3 commit e4f41db

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,32 @@
11
# CoCreate-dashboard
2+
23
A simple dashboard 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/dashboard)
34

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

9-
![CoCreate-boilerplate](https://cdn.cocreate.app/docs/CoCreate-boilerplate.gif)
10+
![CoCreate-dashboard](https://cdn.cocreate.app/docs/CoCreate-dashboard.gif)
1011

1112
## [Docs & Demo](https://cocreate.app/docs/dashboard)
1213

13-
For a complete guide and working demo refer to the [doumentation](https://cocreate.app/docs/boilerplate)
14+
For a complete guide and working demo refer to the [doumentation](https://cocreate.app/docs/dashboard)
1415

1516
## CDN
17+
1618
```html
17-
<script src="https://cdn.cocreate.app/boilerplate/latest/CoCreate-boilerplate.min.js"></script>
19+
<script src="https://cdn.cocreate.app/dashboard/latest/CoCreate-dashboard.min.js"></script>
1820
```
21+
1922
```html
20-
<script src="https://cdn.cocreate.app/boilerplate/latest/CoCreate-boilerplate.min.css"></script>
23+
<script src="https://cdn.cocreate.app/dashboard/latest/CoCreate-dashboard.min.css"></script>
2124
```
2225

2326
## NPM
27+
2428
```shell
25-
$ npm install @cocreate/boilerplate
29+
$ npm install @cocreate/dashboard
2630
```
2731

2832
# Table of Contents
@@ -35,17 +39,19 @@ $ npm install @cocreate/boilerplate
3539
- [License](#license)
3640

3741
<a name="announcements"></a>
42+
3843
# Announcements
3944

40-
All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-dashboard/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-dashboard/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-dashboard/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-dashboard/releases). You may also subscribe to email for releases and breaking changes.
4146

4247
<a name="roadmap"></a>
48+
4349
# Roadmap
4450

4551
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-dashboard/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-dashboard/pulls). We would love to hear your feedback.
4652

47-
4853
<a name="about"></a>
54+
4955
# About
5056

5157
CoCreate-dashboard is guided and supported by the CoCreate Developer Experience Team.
@@ -55,14 +61,15 @@ Please Email the Developer Experience Team [here](mailto:[email protected]) i
5561
CoCreate-dashboard is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
5662

5763
<a name="contribute"></a>
64+
5865
# How to Contribute
5966

6067
We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreate-dashboard/blob/master/CONTRIBUTING.md) guide for details.
6168

62-
We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/CoCreate-boilerplate/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-boilerplate/pulls) or merely upvote or comment on existing issues or pull requests.
69+
We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/CoCreate-dashboard/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-dashboard/pulls) or merely upvote or comment on existing issues or pull requests.
6370

6471
We appreciate your continued support, thank you!
6572

6673
# License
67-
[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-dashboard/blob/master/LICENSE)
6874

75+
[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-dashboard/blob/master/LICENSE)

0 commit comments

Comments
 (0)