Skip to content

Commit 9943227

Browse files
committed
docs: update readme
1 parent 3ed7037 commit 9943227

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
1414

1515
* [Versions](#versions)
1616
* [CoreUI Pro](#coreui-pro)
17+
* [Admin Templates built on top of CoreUI Pro](#admin-templates-built-on-top-of-coreui-pro)
1718
* [Installation](#installation)
18-
* [Create React App](#create-react-app)
19-
* [Usage](#basic-usage)
19+
* [Usage](#usage)
2020
* [What's included](#whats-included)
2121
* [Documentation](#documentation)
2222
* [Contributing](#contributing)
@@ -29,11 +29,12 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
2929

3030
## Versions
3131

32-
* [CoreUI Free Bootstrap Admin Template (Ajax)](https://github.com/coreui/free-bootstrap-admin-template-ajax)
33-
* [CoreUI Free Angular 2+ Admin Template](https://github.com/coreui/free-angular-admin-template)
34-
* [CoreUI Free .NET Core 2 Admin Template](https://github.com/coreui/free-dotnet-admin-template)
35-
* [CoreUI Free React.js Admin Template](https://github.com/coreui/free-react-admin-template)
36-
* [CoreUI Free Vue.js Admin Template](https://github.com/coreui/free-vue-admin-template)
32+
* [CoreUI Free Bootstrap Admin Template](https://github.com/coreui/coreui-free-bootstrap-admin-template)
33+
* [CoreUI Free Bootstrap Admin Template (Ajax)](https://github.com/coreui/coreui-free-bootstrap-admin-template-ajax)
34+
* [CoreUI Free Angular 2+ Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
35+
* 🚧 CoreUI Free .NET Core 2 Admin Template (Available Soon)
36+
* [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template)
37+
* 🚧 CoreUI Free Vue.js Admin Template (Available Soon)
3738

3839
## CoreUI Pro
3940

@@ -43,11 +44,17 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
4344
* 💪 [CoreUI Pro React Admin Template](https://coreui.io/pro/react)
4445
* 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/pro/vue)
4546

47+
## Admin Templates built on top of CoreUI Pro
48+
49+
| CoreUI Pro | Prime | Root | Alba | Leaf |
50+
| --- | --- | --- | --- | --- |
51+
| [![CoreUI Pro React Admin Template](https://coreui.io/assets/img/example-coureui.jpg)](https://coreui.io/pro/react/) | [![Prime React Admin Template](https://genesisui.com/assets/img/templates/prime1280.jpg)](https://genesisui.com/admin-templates/reactjs/prime/?support=1) | [![Root React Admin Template](https://genesisui.com/assets/img/templates/root1280.jpg)](https://genesisui.com/admin-templates/reactjs/root/?support=1) | [![Alba React Admin Template](https://genesisui.com/assets/img/templates/alba1280.jpg)](https://genesisui.com/admin-templates/reactjs/alba/?support=1) | [![Leaf React Admin Template](https://genesisui.com/assets/img/templates/leaf1280.jpg)](https://genesisui.com/admin-templates/reactjs/leaf/?support=1)
52+
4653
## Installation
4754

4855
``` bash
4956
# clone the repo
50-
$ git clone https://github.com/mrholek/CoreUI-React.git my-project
57+
$ git clone https://github.com/coreui/coreui-free-react-admin-template.git my-project
5158

5259
# go into app's directory
5360
$ cd my-project
@@ -59,7 +66,7 @@ $ npm install
5966
## Create React App
6067
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app)
6168

62-
see also:
69+
see also:
6370
[User Guide](CRA.md)
6471

6572
### Basic usage
@@ -73,7 +80,7 @@ Navigate to [http://localhost:3000](http://localhost:3000). The app will automat
7380

7481
### Build
7582

76-
Run `build` to build the project. The build artifacts will be stored in the `build/` directory.
83+
Run `build` to build the project. The build artifacts will be stored in the `build/` directory.
7784

7885
```bash
7986
# build for production with minification
@@ -110,15 +117,15 @@ The documentation for the CoreUI Admin Template is hosted at our website [CoreU
110117

111118
## Contributing
112119

113-
Please read through our [contributing guidelines](https://github.com/mrholek/CoreUI-Free-Bootstrap-Admin-Template/blob/v2.0.0/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
120+
Please read through our [contributing guidelines](https://github.com/coreui/coreui-free-react-admin-template/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
114121

115-
Editor preferences are available in the [editor config](https://github.com/mrholek/CoreUI-Free-Bootstrap-Admin-Template/blob/v2.0.0/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
122+
Editor preferences are available in the [editor config](https://github.com/coreui/coreui-free-react-admin-template/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
116123

117124
## Versioning
118125

119126
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/).
120127

121-
See [the Releases section of our project](https://github.com/mrholek/CoreUI-React/releases) for changelogs for each release version.
128+
See [the Releases section of our project](https://github.com/coreui/coreui-free-react-admin-template/releases) for changelogs for each release version.
122129

123130
## Creators
124131

@@ -133,7 +140,7 @@ See [the Releases section of our project](https://github.com/mrholek/CoreUI-Reac
133140

134141
Get updates on CoreUI's development and chat with the project maintainers and community members.
135142

136-
- Follow [@coreuikit on Twitter](https://twitter.com/coreuikit).
143+
- Follow [@core_ui on Twitter](https://twitter.com/core_ui).
137144
- Read and subscribe to [CoreUI Blog](https://coreui.ui/blog/).
138145

139146
### Community Projects

0 commit comments

Comments
 (0)