Skip to content

Commit e745894

Browse files
xidedixxidedix
committed
doc: package readme update
1 parent 93ce706 commit e745894

File tree

1 file changed

+41
-13
lines changed

1 file changed

+41
-13
lines changed

‎projects/coreui/angular/README.md

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
# [@coreui/angular](https://coreui.io/angular)
22

3-
[![@coreui angular](https://img.shields.io/badge/@coreui%20-angular-lightgrey.svg?style=flat-square)](https://github.com/coreui/angular)
4-
[![npm package][npm-coreui-angular-badge]][npm-coreui-angular]
5-
[![NPM downloads][npm-coreui-angular-download]][npm-coreui-angular]
6-
[![@coreui angular-next](https://img.shields.io/badge/@coreui%[email protected]?style=flat-square)](https://github.com/coreui/coreui-angular)
7-
[![npm-coreui-angular-next][npm-coreui-angular-next]][npm-coreui-angular]
3+
[![npm package][npm-coreui-angular-badge-latest]][npm-coreui-angular]
4+
[![NPM downloads][npm-coreui-angular-download]][npm-coreui-angular]
5+
[![npm-coreui-angular-next][npm-coreui-angular-badge-next]][npm-coreui-angular]
86
[![@coreui coreui](https://img.shields.io/badge/@coreui%20-coreui-lightgrey.svg?style=flat-square)](https://github.com/coreui/coreui)
97
[![npm package][npm-coreui-badge]][npm-coreui]
108
[![NPM downloads][npm-coreui-download]][npm-coreui]
11-
![angular](https://img.shields.io/badge/angular-^8.2.0-lightgrey.svg?style=flat-square)
9+
![angular](https://img.shields.io/badge/angular-^9.0.0--rc.5-lightgrey.svg?style=flat-square&logo=angular)
1210

1311
[npm-coreui-angular]: https://www.npmjs.com/package/@coreui/angular
14-
[npm-coreui-angular-badge]: https://img.shields.io/npm/v/@coreui/angular.png?style=flat-square
12+
[npm-coreui-angular-badge-latest]: https://img.shields.io/npm/v/@coreui/angular/latest?style=flat-square&color=red
13+
[npm-coreui-angular-badge-next]: https://img.shields.io/npm/v/@coreui/angular/next?style=flat-square&color=red
1514
[npm-coreui-angular-download]: https://img.shields.io/npm/dm/@coreui/angular.svg?style=flat-square
16-
[npm-coreui-angular-next]: https://img.shields.io/npm/v/@coreui/angular/next.png?style=flat-square
15+
[npm-coreui-angular-next]: https://img.shields.io/npm/v/@coreui/angular/next?style=flat-square
1716
[npm-coreui]: https://www.npmjs.com/package/@coreui/coreui
1817
[npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square
1918
[npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square
@@ -26,7 +25,7 @@
2625
Before you begin, make sure your development environment includes `Node.js®` and an `npm` package manager.
2726

2827
###### Node.js
29-
Angular requires `Node.js` version 8.x or 10.x.
28+
Angular 9 requires `Node.js` version 12.x
3029

3130
- To check your version, run `node -v` in a terminal/console window.
3231
- To get `Node.js`, go to [nodejs.org](https://nodejs.org/).
@@ -37,10 +36,39 @@ Install the Angular CLI globally using a terminal/console window.
3736
npm install -g @angular/cli
3837
```
3938

40-
### Installation
41-
Go to the workspace folder and install `@coreui/angular` as a dependency.
42-
```bash
43-
npm install @coreui/angular
39+
##### Update to Angular 9
40+
see: [https://update.angular.io](https://update.angular.io)
41+
42+
## CoreUI Installation
43+
44+
Several options are available:
45+
46+
### Clone repo
47+
48+
``` bash
49+
$ git clone https://github.com/coreui/coreui-angular.git
50+
```
51+
52+
### NPM
53+
54+
``` bash
55+
$ npm install @coreui/angular --save
56+
```
57+
58+
### Yarn
59+
60+
``` bash
61+
$ yarn add @coreui/angular
62+
```
63+
64+
## Usage
65+
66+
### CSS
67+
68+
Copy-paste the stylesheet `<link>` into your `<head>` before all other stylesheets to load our CSS.
69+
70+
``` html
71+
<link rel="stylesheet" href="node_modules/@coreui/coreui/dist/css/coreui.min.css">
4472
```
4573

4674
### Changelog

0 commit comments

Comments
 (0)