Skip to content

Commit f036eda

Browse files
committed
docs: update README
1 parent be707ad commit f036eda

File tree

1 file changed

+33
-17
lines changed

1 file changed

+33
-17
lines changed

Diff for: README.md

+33-17
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
</a>
99
</p>
1010

11-
<h3 align="center">CoreUI</h3>
11+
<h3 align="center">CoreUI for React.js</h3>
1212

1313
<p align="center">
1414
React.js Components Library built on top of Bootstrap 5 and TypeScript.
1515
<br>
16-
<a href="https://coreui.io/react/docs/4.0/getting-started/introduction"><strong>Explore CoreUI docs »</strong></a>
16+
<a href="https://coreui.io/react/docs/getting-started/introduction"><strong>Explore CoreUI for React.js docs »</strong></a>
1717
<br>
1818
<br>
1919
<a href="https://github.com/coreui/coreui-react/issues/new?template=bug_report.md">Report bug</a>
@@ -45,23 +45,29 @@
4545

4646
Several quick start options are available:
4747

48-
- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.0.0-alpha.0.zip)
48+
- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.0.0-rc.4.zip)
4949
- Clone the repo: `git clone https://github.com/coreui/coreui-react.git`
5050
- Install with [npm](https://www.npmjs.com/): `npm install @coreui/react@next`
5151
- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/react@next`
5252

53-
Read the [Getting started page](https://coreui.io/react/docs/4.0/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
53+
Read the [Getting started page](https://coreui.io/react/docs/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
5454

5555
### Stylesheets
5656

57-
React components are styled using `@coreui/coreui` CSS library, but you can use them also with bootstrap CSS library. That is possible because `@coreui/coreui` library is compatible with bootstrap, it just extends its functionalities. The only exception is custom CoreUI components, which don't exist in the Bootstrap ecosystem.
57+
React components are styled using `@coreui/coreui` CSS library, but you can use them also with bootstrap CSS library. That is possible because `@coreui/coreui` library is compatible with bootstrap, it just extends its functionalities. The only exception are custom CoreUI components, which don't exist in the Bootstrap ecosystem.
5858

5959
#### CoreUI CSS files
6060

6161
##### Installation
6262

6363
```bash
64-
npm install @coreui/coreui@next
64+
yarn add @coreui/coreui
65+
```
66+
67+
or
68+
69+
```bash
70+
npm install @coreui/coreui --save
6571
```
6672

6773
##### Basic usage
@@ -75,7 +81,13 @@ import "@coreui/dist/css/coreui.min.css";
7581
##### Installation
7682

7783
```bash
78-
npm install bootstrap@next
84+
yarn add bootstrap
85+
```
86+
87+
or
88+
89+
```bash
90+
npm install bootstrap
7991
```
8092

8193
##### Basic usage
@@ -90,34 +102,34 @@ import "bootstrap/dist/css/bootstrap.min.css";
90102
[![npm version](https://img.shields.io/npm/v/@coreui/react)](https://www.npmjs.com/package/@coreui/react)
91103
[![peerDependencies Status](https://img.shields.io/david/peer/coreui/coreui)](https://david-dm.org/coreui/coreui?type=peer)
92104
[![devDependency Status](https://img.shields.io/david/dev/coreui/coreui)](https://david-dm.org/coreui/coreui?type=dev)
93-
[![Coverage Status](https://img.shields.io/coveralls/github/coreui/coreui-react/v4-dev)](https://coveralls.io/github/coreui/coreui-react?branch=v4-dev)
105+
[![Coverage Status](https://img.shields.io/coveralls/github/coreui/coreui-react/v4)](https://coveralls.io/github/coreui/coreui-react?branch=v4)
94106

95107
## Bugs and feature requests
96108

97-
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/coreui/coreui-react/blob/v4-dev/.github/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/coreui/coreui-react/issues/new).
109+
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/coreui/coreui-react/blob/v4/.github/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/coreui/coreui-react/issues/new).
98110

99111
## Documentation
100112

101-
The documentation for the CoreUI & CoreUI PRO is hosted at our website [CoreUI for React](https://coreui.io/react/docs/4.0/getting-started/introduction)
113+
The documentation for the CoreUI & CoreUI PRO is hosted at our website [CoreUI for React](https://coreui.io/react/docs/getting-started/introduction)
102114

103115
### Running documentation locally
104116

105-
1. Run `yarn install` to install the Node.js dependencies, including Hugo (the site builder).
106-
2. Run `yarn docz:build` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
107-
3. From the root directory, run `yarn docz:serve` in the command line.
108-
4. Open `http://localhost:3000/` in your browser, and voilà.
117+
1. Run `yarn install` or `npm install` to install the Node.js dependencies.
118+
2. Run `yarn bootstrap` or `npm run bootstrap` to link local packages together and install remaining package dependencies.
119+
3. From the root directory, run `yarn docs:dev` or `npm run docs:dev` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
120+
4. Open `http://localhost:8000/` in your browser, and voilà.
109121

110122
## Contributing
111123

112-
Please read through our [contributing guidelines](https://github.com/coreui/coreui-react/blob/v4-dev/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
124+
Please read through our [contributing guidelines](https://github.com/coreui/coreui-react/blob/v4/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
113125

114-
Editor preferences are available in the [editor config](https://github.com/coreui/coreui-react/blob/v4-dev/.editorconfig) for easy use in common text editors. Read more and download plugins at <https://editorconfig.org/>.
126+
Editor preferences are available in the [editor config](https://github.com/coreui/coreui-react/blob/v4/.editorconfig) for easy use in common text editors. Read more and download plugins at <https://editorconfig.org/>.
115127

116128
## Community
117129

118130
Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.
119131

120-
- Read and subscribe to [The Official CoreUI Blog](https://coreui.io/blog/).
132+
- Read and subscribe to [The Official CoreUI Blog](https://blog.coreui.io/).
121133
- Join [the official Community](https://community.coreui.io/).
122134

123135
You can also follow [@core_ui on Twitter](https://twitter.com/core_ui).
@@ -139,6 +151,10 @@ See [the Releases section of our project](https://github.com/coreui/coreui-react
139151

140152
- <https://github.com/xidedix>
141153

154+
**The CoreUI Team**
155+
156+
- <https://github.com/orgs/coreui/people>
157+
142158
## Copyright and license
143159

144160
Copyright 2021 creativeLabs Łukasz Holeczek. Code released under the [MIT License](https://github.com/coreui/coreui-react/blob/v4-dev/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).

0 commit comments

Comments
 (0)