@coreui/angular 3.0.0-alpha.6 → 4.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 creativeLabs Łukasz Holeczek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,52 +1,150 @@
-# [@coreui/angular v3](https://coreui.io/angular) **alpha**
+<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>
 
-[![@coreui angular](https://img.shields.io/badge/@coreui%20-angular-lightgrey.svg?style=flat-square)](https://github.com/coreui/angular)
-[![npm package][npm-coreui-angular-badge]][npm-coreui-angular] 
-[![NPM downloads][npm-coreui-angular-download]][npm-coreui-angular]  
-[![@coreui angular-next](https://img.shields.io/badge/@coreui%20-angular@next-lightgrey.svg?style=flat-square)](https://github.com/coreui/coreui-angular)
-[![npm-coreui-angular-next][npm-coreui-angular-next]][npm-coreui-angular]  
-[![@coreui coreui](https://img.shields.io/badge/@coreui%20-coreui-lightgrey.svg?style=flat-square)](https://github.com/coreui/coreui)
-[![npm package][npm-coreui-badge]][npm-coreui]
-[![NPM downloads][npm-coreui-download]][npm-coreui]    
-![angular](https://img.shields.io/badge/angular-^9.1.12-lightgrey.svg?style=flat-square&logo=angular)
+<h3 align="center">CoreUI for Angular</h3>
+<h6 align="center"><small>(v4 alpha)</small></h6>
 
-[npm-coreui-angular]: https://www.npmjs.com/package/@coreui/angular  
-[npm-coreui-angular-badge]: https://img.shields.io/npm/v/@coreui/angular.png?style=flat-square  
-[npm-coreui-angular-download]: https://img.shields.io/npm/dm/@coreui/angular.svg?style=flat-square  
-[npm-coreui-angular-next]: https://img.shields.io/npm/v/@coreui/angular/next.png?style=flat-square
-[npm-coreui]: https://www.npmjs.com/package/@coreui/coreui
-[npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square
-[npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square
+<p align="center">
+  Angular Components Library built on top of Bootstrap 5 and TypeScript.
+  <br>
+  <a href="https://coreui.io/angular/docs/4.0/"><strong>Explore CoreUI for Angular docs »</strong></a>
+  <br>
+  <br>
+  <a href="https://github.com/coreui/coreui-angular/issues/new?template=bug_report.md">Report a bug</a>
+  ·
+  <a href="https://github.com/coreui/coreui-angular/issues/new?template=feature_request.md">Request a feature</a>
+  ·
+  <a href="https://blog.coreui.io/">Blog</a>
+</p>
 
-> [@coreui/angular v3](https://coreui.io/angular) library project  
-> for use with [CoreUI v3 Angular Admin Template](https://coreui.io/angular/) Bootstrap Admin Template
+## Table of contents
 
+- [Quick start](#quick-start)
+- [Status](#status)
+- [Templates](#templates)
+- [Bugs and feature requests](#bugs-and-feature-requests)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [Community](#community)
+- [Versioning](#versioning)
+- [Creators](#creators)
+- [Copyright and license](#copyright-and-license)
 
-#### Prerequisites
-Before you begin, make sure your development environment includes `Node.js®` and an `npm` package manager.
+## Quick start
+
+### Prerequisites
+Before you begin, make sure your development environment includes `Node.js®` and `npm` package manager.
 
 ###### Node.js
-Angular 9 requires `Node.js` version 10.13 or later.
+Angular 12 requires `Node.js` version `^12.20` or `^14`. 
 
 - To check your version, run `node -v` in a terminal/console window.
 - To get `Node.js`, go to [nodejs.org](https://nodejs.org/).
 
 ###### Angular CLI
 Install the Angular CLI globally using a terminal/console window.
+
 ```bash
 npm install -g @angular/cli
 ```
 
-### Installation
-Go to the workspace folder and install `@coreui/angular` as a dependency.
-```bash 
-npm install @coreui/angular@next
+### Instalation
+Several quick start options are available (pick one):
+
+- [Download the latest release](https://github.com/coreui/coreui-angular/)
+- Clone the repo: `git clone https://github.com/coreui/coreui-angular.git`
+- Install with [npm](https://www.npmjs.com/): `npm install @coreui/angular`
+- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/angular`
+
+Read the [Getting started page](https://coreui.io/angular/docs/4.0/) for information on the framework contents, templates and examples, and more.
+
+#### CoreUI CSS files
+
+##### Installation
+
+```bash
+npm install @coreui/coreui --save
+```
+
+##### Basic usage
+
+```scss
+import '~@coreui/coreui/dist/css/coreui.min.css'
+```
+
+#### Bootstrap CSS files
+
+##### Installation (optional)
+
+```bash
+npm install bootstrap
 ```
 
-### Changelog
+## Status
+
+[![npm-coreui-angular-next][npm-coreui-angular-badge-next]][npm-coreui-angular]
+[![NPM downloads][npm-coreui-angular-download]][npm-coreui-angular]
+![angular](https://img.shields.io/badge/angular-^12.2.0-lightgrey.svg?style=flat-square&logo=angular)  
+
+[npm-coreui-angular-badge-next]: https://img.shields.io/npm/v/@coreui/angular/next?style=flat-square&color=red
+[npm-coreui-angular]: https://www.npmjs.com/package/@coreui/angular
+[npm-coreui-angular-download]: https://img.shields.io/npm/dm/@coreui/angular.svg?style=flat-square
+
+## Templates
+
+* [CoreUI Free Angular Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
+* 💪  [CoreUI Pro Angular Admin Template](https://coreui.io/pro/angular/)
+
+## Bugs and feature requests
+
+Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/coreui/coreui-angular/blob/main/.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-angular/issues/new).
+
+## Documentation
+
+The documentation for the CoreUI & CoreUI PRO is hosted at our website [CoreUI for Angular](https://coreui.io/angular/docs/4.0/)
+
+## Contributing
+
+Please read through our [contributing guidelines](https://github.com/coreui/coreui-angular/blob/main/.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-angular/blob/main/.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://blog.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-angular/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>
+
+**The CoreUI Team**
 
-See the GitHub [release history](https://github.com/coreui/coreui-angular/releases).
+- <https://github.com/orgs/coreui/people>
 
-### Contributing
+## Copyright and license
 
-See [CONTRIBUTING.md](https://github.com/coreui/coreui-angular/blob/master/CONTRIBUTING.md).
+Copyright 2021 creativeLabs Łukasz Holeczek. Code released under the [MIT License](https://github.com/coreui/coreui-angular/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).