Skip to content

Commit e9cf88f

Browse files
committed
docs(readme): update
1 parent e368d57 commit e9cf88f

File tree

1 file changed

+44
-21
lines changed

1 file changed

+44
-21
lines changed

README.md

Lines changed: 44 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,31 @@
55
[![@coreui coreui](https://img.shields.io/badge/@coreui%20-coreui-lightgrey.svg?style=flat-square)](https://github.com/coreui/coreui)
66
[![npm package][npm-coreui-badge]][npm-coreui]
77
[![NPM downloads][npm-coreui-download]][npm-coreui]
8-
![angular](https://img.shields.io/badge/angular-^17.3.0-lightgrey.svg?style=flat-square&logo=angular)
8+
![angular](https://img.shields.io/badge/angular-^18.0.0-lightgrey.svg?style=flat-square&logo=angular)
99

1010
[npm-coreui-angular]: https://www.npmjs.com/package/@coreui/angular
11+
1112
[npm-coreui-angular-badge]: https://img.shields.io/npm/v/@coreui/angular.png?style=flat-square
13+
1214
[npm-coreui-angular-badge-next]: https://img.shields.io/npm/v/@coreui/angular/next?style=flat-square&color=red
15+
1316
[npm-coreui-angular-download]: https://img.shields.io/npm/dm/@coreui/angular.svg?style=flat-square
17+
1418
[npm-coreui]: https://www.npmjs.com/package/@coreui/coreui
19+
1520
[npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square
21+
1622
[npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square
1723

18-
# CoreUI Free Admin Dashboard Template for Angular 17
24+
# CoreUI Free Admin Dashboard Template for Angular 18
1925

20-
CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all!
26+
CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user
27+
experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you
28+
customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all!
2129

22-
- [CoreUI Angular Admin Dashboard Template & UI Components Library](https://coreui.io/angular)
30+
- [CoreUI Angular Admin Dashboard Template & UI Components Library](https://coreui.io/angular)
2331
- [CoreUI Angular Demo](https://coreui.io/angular/demo/5.0/free/)
24-
- [CoreUI Angular Docs](https://coreui.io/angular/docs/)
32+
- [CoreUI Angular Docs](https://coreui.io/angular/docs/)
2533

2634
## Table of Contents
2735

@@ -62,23 +70,26 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
6270
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
6371
| [![CoreUI PRO Angular Admin Template](https://coreui.io/images/templates/coreui_pro_default_v3_light_dark.webp)](https://coreui.io/product/angular-dashboard-template/?theme=default-v3) | [![CoreUI PRO React Admin Template](https://coreui.io/images/templates/coreui_pro_light_v3_light_dark.webp)](https://coreui.io/product/angular-dashboard-template/?theme=light) |
6472

65-
6673
## Quick Start
6774

6875
- [Download the latest release](https://github.com/coreui/coreui-free-angular-admin-template/)
6976
- Clone the repo: `git clone https://github.com/coreui/coreui-free-angular-admin-template.git`
7077

7178
#### <i>Prerequisites</i>
79+
7280
Before you begin, make sure your development environment includes `Node.js®` and an `npm` package manager.
7381

7482
###### Node.js
75-
[**Angular 17**](https://angular.io/guide/what-is-angular) requires `Node.js` LTS version `^18.13` or `^20.09`.
83+
84+
[**Angular 18**](https://angular.io/guide/what-is-angular) requires `Node.js` LTS version `^18.19` or `^20.09`.
7685

7786
- To check your version, run `node -v` in a terminal/console window.
7887
- To get `Node.js`, go to [nodejs.org](https://nodejs.org/).
7988

8089
###### Angular CLI
90+
8191
Install the Angular CLI globally using a terminal/console window.
92+
8293
```bash
8394
npm install -g @angular/cli
8495
```
@@ -107,9 +118,11 @@ Run `build` to build the project. The build artifacts will be stored in the `dis
107118
# build for production with minification
108119
$ npm run build
109120
```
121+
110122
## What's included
111123

112-
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
124+
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations.
125+
You'll see something like this:
113126

114127
```
115128
coreui-free-angular-admin-template
@@ -136,11 +149,12 @@ The documentation for the CoreUI Admin Template is hosted at our website [CoreUI
136149

137150
---
138151

139-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.0.0.
152+
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.0.0.
140153

141154
## Versioning
142155

143-
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained under [the Semantic Versioning guidelines](http://semver.org/).
156+
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained
157+
under [the Semantic Versioning guidelines](http://semver.org/).
144158

145159
See [the Releases section of our project](https://github.com/coreui/coreui-free-angular-admin-template/releases) for changelogs for each release version.
146160

@@ -162,7 +176,8 @@ Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.
162176

163177
## Running end-to-end tests
164178

165-
Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
179+
Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end
180+
testing capabilities.
166181

167182
## Further help
168183

@@ -171,11 +186,13 @@ To get more help on the Angular CLI use `ng help` or go check out the [Angular C
171186
## Creators
172187

173188
**Łukasz Holeczek**
189+
174190
* <https://twitter.com/lukaszholeczek>
175191
* <https://github.com/mrholek>
176192
* <https://github.com/coreui>
177193

178194
**CoreUI team**
195+
179196
* https://github.com/orgs/coreui/people
180197

181198
## Community
@@ -187,33 +204,39 @@ Get updates on CoreUI's development and chat with the project maintainers and co
187204

188205
## Support CoreUI Development
189206

190-
CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the [CoreUI PRO](https://coreui.io/pricing/) or by becoming a sponsor via [Open Collective](https://opencollective.com/coreui/).
207+
CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the
208+
project is not sustainable without proper financial backing. You can support development by buying the [CoreUI PRO](https://coreui.io/pricing/) or by becoming a
209+
sponsor via [Open Collective](https://opencollective.com/coreui/).
191210

192211
<!--- StartOpenCollectiveBackers -->
193212

194213
### Platinum Sponsors
195214

196-
Support this project by [becoming a Platinum Sponsor](https://opencollective.com/coreui/contribute/platinum-sponsor-40959/). A large company logo will be added here with a link to your website.
215+
Support this project by [becoming a Platinum Sponsor](https://opencollective.com/coreui/contribute/platinum-sponsor-40959/). A large company logo will be added
216+
here with a link to your website.
197217

198218
<a href="https://opencollective.com/coreui/contribute/platinum-sponsor-40959/checkout"><img src="https://opencollective.com/coreui/tiers/platinum-sponsor/0/avatar.svg?avatarHeight=100"></a>
199219

200220
### Gold Sponsors
201221

202-
Support this project by [becoming a Gold Sponsor](https://opencollective.com/coreui/contribute/gold-sponsor-40960/). A big company logo will be added here with a link to your website.
222+
Support this project by [becoming a Gold Sponsor](https://opencollective.com/coreui/contribute/gold-sponsor-40960/). A big company logo will be added here with
223+
a link to your website.
203224

204-
<a href="https://opencollective.com/coreui/contribute/gold-sponsor-40960/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
225+
<a href="https://opencollective.com/coreui/contribute/gold-sponsor-40960/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
205226

206227
### Silver Sponsors
207228

208-
Support this project by [becoming a Silver Sponsor](https://opencollective.com/coreui/contribute/silver-sponsor-40967/). A medium company logo will be added here with a link to your website.
229+
Support this project by [becoming a Silver Sponsor](https://opencollective.com/coreui/contribute/silver-sponsor-40967/). A medium company logo will be added
230+
here with a link to your website.
209231

210232
<a href="https://opencollective.com/coreui/contribute/silver-sponsor-40967/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
211233

212234
### Bronze Sponsors
213235

214-
Support this project by [becoming a Bronze Sponsor](https://opencollective.com/coreui/contribute/bronze-sponsor-40966/). The company avatar will show up here with a link to your OpenCollective Profile.
236+
Support this project by [becoming a Bronze Sponsor](https://opencollective.com/coreui/contribute/bronze-sponsor-40966/). The company avatar will show up here
237+
with a link to your OpenCollective Profile.
215238

216-
<a href="https://opencollective.com/coreui/contribute/bronze-sponsor-40966/checkout"><img src="https://opencollective.com/coreui/tiers/bronze-sponsor/0/avatar.svg?avatarHeight=100"></a>
239+
<a href="https://opencollective.com/coreui/contribute/bronze-sponsor-40966/checkout"><img src="https://opencollective.com/coreui/tiers/bronze-sponsor/0/avatar.svg?avatarHeight=100"></a>
217240

218241
### Backers
219242

@@ -225,8 +248,8 @@ Thanks to all the backers and sponsors! Support this project by [becoming a back
225248

226249
## Copyright and License
227250

228-
copyright 2024 creativeLabs Łukasz Holeczek.
251+
copyright 2024 creativeLabs Łukasz Holeczek.
229252

230-
231253
Code released under [the MIT license](https://github.com/coreui/coreui-free-react-admin-template/blob/master/LICENSE).
232-
There is only one limitation you can't re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In the past, we faced some problems with persons who tried to sell CoreUI based templates.
254+
There is only one limitation you can't re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In the past, we faced some problems with
255+
persons who tried to sell CoreUI based templates.

0 commit comments

Comments
 (0)