Skip to content

Commit

Permalink
relese: v4.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
mrholek committed Nov 8, 2021
1 parent 482560f commit d109bc3
Show file tree
Hide file tree
Showing 9 changed files with 162 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ See the [contributing guidelines](CONTRIBUTING.md) for sharing bug reports.

For general troubleshooting or help getting started:

- Join [the official community](https://community.coreui.io/).
- Join [GitHub Discussions](https://github.com/coreui/coreui-react/discussions/).
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@
·
<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>

Expand All @@ -45,7 +43,7 @@

Several quick start options are available:

- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.0.0.zip)
- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.0.1.zip)
- Clone the repo: `git clone https://github.com/coreui/coreui-react.git`
- Install with [npm](https://www.npmjs.com/): `npm install @coreui/react`
- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/react`
Expand Down Expand Up @@ -130,7 +128,6 @@ Editor preferences are available in the [editor config](https://github.com/coreu
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/).
- Join [the official Community](https://community.coreui.io/).

You can also follow [@core_ui on Twitter](https://twitter.com/core_ui).

Expand Down
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
"packages/*"
],
"useWorkspaces": true,
"version": "4.0.0"
"version": "4.0.1"
}
2 changes: 0 additions & 2 deletions packages/coreui-react-chartjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
·
<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>

Expand Down
157 changes: 157 additions & 0 deletions packages/coreui-react/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
<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 for React.js</h3>

<p align="center">
React.js Components Library built on top of Bootstrap 5 and TypeScript.
<br>
<a href="https://coreui.io/react/docs/getting-started/introduction"><strong>Explore CoreUI for React.js 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://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.1.zip)
- Clone the repo: `git clone https://github.com/coreui/coreui-react.git`
- Install with [npm](https://www.npmjs.com/): `npm install @coreui/react`
- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/react`

Read the [Getting started page](https://coreui.io/react/docs/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 are custom CoreUI components, which don't exist in the Bootstrap ecosystem.

#### CoreUI CSS files

##### Installation

```bash
yarn add @coreui/coreui
```

or

```bash
npm install @coreui/coreui --save
```

##### Basic usage

```js
import '@coreui/coreui/dist/css/coreui.min.css'
```

#### Bootstrap CSS files

##### Installation

```bash
yarn add bootstrap
```

or

```bash
npm install bootstrap
```

##### 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)](https://coveralls.io/github/coreui/coreui-react?branch=v4)

## 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/.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/getting-started/introduction)

### Running documentation locally

1. Run `yarn install` or `npm install` to install the Node.js dependencies.
2. Run `yarn bootstrap` or `npm run bootstrap` to link local packages together and install remaining package dependencies.
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.
4. Open `http://localhost:8000/` in your browser, and voilà.

## Contributing

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.

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/>.

## 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-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>

**The CoreUI Team**

- <https://github.com/orgs/coreui/people>

## Copyright and license

Copyright 2021 creativeLabs Łukasz Holeczek. Code released under the [MIT License](https://github.com/coreui/coreui-react/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).
2 changes: 1 addition & 1 deletion packages/coreui-react/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@coreui/react",
"version": "4.0.0",
"version": "4.0.1",
"description": "UI Components Library for React.js",
"keywords": [
"react",
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@coreui/react-docs",
"version": "4.0.0",
"version": "4.0.1",
"private": true,
"description": "",
"homepage": "https://coreui.io/react/",
Expand Down
3 changes: 0 additions & 3 deletions packages/docs/src/components/Footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ const Footer: FC = () => {
<li className="d-inline-block ms-3">
<a href="https://twitter.com/core_ui">Twitter</a>
</li>
<li className="d-inline-block ms-3">
<a href="https://community.coreui.io/">Community</a>
</li>
<li className="d-inline-block ms-3 ps-3 border-start border-2">
<a href="https://coreui.io/">CoreUI (Vanilla)</a>
</li>
Expand Down
3 changes: 0 additions & 3 deletions packages/docs/src/components/Header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,6 @@ const Header: FC = () => {
<CIcon icon={cilMenu} size="lg" />
</CHeaderToggler>
<CHeaderNav className="ms-auto">
<CNavItem href="https://community.coreui.io/">
<CIcon icon={cibDiscourse} size="xl" />
</CNavItem>
<CNavItem href="https://github.com/coreui/coreui-react/">
<CIcon icon={cibGithub} size="xl" />
</CNavItem>
Expand Down

0 comments on commit d109bc3

Please sign in to comment.