build: readme to avoid docz conficts

Author: mrholek

README

@@ -0,0 +1,144 @@
+<p align="center">
+  <a href="https://coreui.io/">
+    <img
+      src="https://coreui.io/images/brand/coreui-signet.svg"
+      alt="CoreUI logo"
+      width="200"
+    />
+  </a>
+</p>
+
+<h3 align="center">CoreUI</h3>
+
+<p align="center">
+  React.js Components Library built on top of Bootstrap 5 and TypeScript.
+  <br>
+  <a href="https://coreui.io/react/docs/4.0/getting-started/introduction"><strong>Explore CoreUI docs »</strong></a>
+  <br>
+  <br>
+  <a href="https://github.com/coreui/coreui-react/issues/new?template=bug_report.md">Report bug</a>
+  ·
+  <a href="https://github.com/coreui/coreui-react/issues/new?template=feature_request.md">Request feature</a>
+  ·
+  <a href="https://community.coreui.io/">Community</a>
+  ·
+  <a href="https://blog.coreui.io/">Blog</a>
+</p>
+
+
+## Table of contents
+
+- [Quick start](#quick-start)
+- [Status](#status)
+- [What's included](#whats-included)
+- [Bugs and feature requests](#bugs-and-feature-requests)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [Community](#community)
+- [Versioning](#versioning)
+- [Creators](#creators)
+- [Copyright and license](#copyright-and-license)
+
+## Quick start
+
+### Instalation
+
+Several quick start options are available:
+
+- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.0.0-alpha.0.zip)
+- Clone the repo: `git clone https://github.com/coreui/coreui-react.git`
+- Install with [npm](https://www.npmjs.com/): `npm install @coreui/react@next`
+- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/react@next`
+
+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.
+
+### Stylesheets
+
+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.
+
+#### CoreUI CSS files
+
+##### Installation
+
+```bash
+npm install @coreui/coreui@next
+```
+
+##### Basic usage
+
+```js
+import "@coreui/dist/css/coreui.min.css";
+```
+
+#### Bootstrap CSS files
+
+##### Installation
+
+```bash
+npm install bootstrap@next
+```
+
+##### Basic usage
+
+```js
+import "bootstrap/dist/css/bootstrap.min.css";
+```
+
+## Status
+
+[![Build Status](https://github.com/coreui/coreui-react/workflows/JS%20Tests/badge.svg?branch=main)](https://github.com/coreui/coreui-react/actions?query=workflow%3AJS+Tests+branch%3Amain)
+[![npm version](https://img.shields.io/npm/v/@coreui/react)](https://www.npmjs.com/package/@coreui/react)
+[![peerDependencies Status](https://img.shields.io/david/peer/coreui/coreui)](https://david-dm.org/coreui/coreui?type=peer)
+[![devDependency Status](https://img.shields.io/david/dev/coreui/coreui)](https://david-dm.org/coreui/coreui?type=dev)
+[![Coverage Status](https://img.shields.io/coveralls/github/coreui/coreui-react/v4-dev)](https://coveralls.io/github/coreui/coreui-react?branch=v4-dev)
+
+## Bugs and feature requests
+
+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).
+
+## Documentation
+
+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)
+
+### Running documentation locally
+
+1. Run `yarn install` to install the Node.js dependencies, including Hugo (the site builder).
+2. Run `yarn docz:build` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
+3. From the root directory, run `yarn docz:serve` in the command line.
+4. Open `http://localhost:3000/` in your browser, and voilà.
+
+## Contributing
+
+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.
+
+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/>.
+
+## Community
+
+Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.
+
+- Read and subscribe to [The Official CoreUI Blog](https://coreui.io/blog/).
+- Join [the official Community](https://community.coreui.io/).
+
+You can also follow [@core_ui on Twitter](https://twitter.com/core_ui).
+
+## Versioning
+
+For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained under [the Semantic Versioning guidelines](http://semver.org/).
+
+See [the Releases section of our project](https://github.com/coreui/coreui-react/releases) for changelogs for each release version.
+
+## Creators
+
+**Łukasz Holeczek**
+
+- <https://twitter.com/lukaszholeczek>
+- <https://github.com/mrholek>
+
+**Andrzej Kopański**
+
+- <https://github.com/xidedix>
+
+## Copyright and license
+
+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/).