8000 Update README.md · pny-htun/coreui-react@62fd159 · GitHub
[go: up one dir, main page]
Skip to content

Commit 62fd159

Browse files
mrholekmrholek
authored
Update README.md
1 parent ffde383 commit 62fd159

File tree

1 file changed

+111
-7
lines changed

1 file changed

+111
-7
lines changed

‎packages/coreui-react/README.md

Lines changed: 111 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,24 @@
2020
·
2121
<a href 8000 ="https://github.com/coreui/coreui-react/issues/new?template=feature_request.md">Request feature</a>
2222
·
23-
<a href="https://blog.coreui.io/">Blog</a>
23+
<a href="https://coreui.io/blog/">Blog</a>
2424
</p>
2525

2626

2727
## Table of contents
2828

2929
- [Quick start](#quick-start)
30+
- [Components](#components)
3031
- [Status](#status)
31-
- [What's included](#whats-included)
3232
- [Bugs and feature requests](#bugs-and-feature-requests)
3333
- [Documentation](#documentation)
34+
- [Frameworks](#frameworks)
35+
- [Templates](#templates)
3436
- [Contributing](#contributing)
3537
- [Community](#community)
3638
- [Versioning](#versioning)
3739
- [Creators](#creators)
40+
- [Support CoreUI Development](#support-coreui-development)
3841
- [Copyright and license](#copyright-and-license)
3942

4043
## Quick start
@@ -94,13 +97,58 @@ npm install bootstrap
9497
import "bootstrap/dist/css/bootstrap.min.css";
9598
```
9699

100+
## Components
101+
102+
- [React Accordion](https://coreui.io/react/docs/components/accordion/)
103+
- [React Alert](https://coreui.io/react/docs/components/alert/)
104+
- [React Avatar](https://coreui.io/react/docs/components/avatar/)
105+
- [React Badge](https://coreui.io/react/docs/components/badge/)
106+
- [React Breadcrumb](https://coreui.io/react/docs/components/breadcrumb/)
107+
- [React Button](https://coreui.io/react/docs/components/button/)
108+
- [React Button Group](https://coreui.io/react/docs/components/button-group/)
109+
- [React Callout](https://coreui.io/react/docs/components/callout/)
110+
- [React Card](https://coreui.io/react/docs/components/card/)
111+
- [React Carousel](https://coreui.io/react/docs/components/carousel/)
112+
- [React Checkbox](https://coreui.io/react/docs/forms/checkbox/)
113+
- [React Close Button](https://coreui.io/react/docs/components/close-button/)
114+
- [React Collapse](https://coreui.io/react/docs/components/collapse/)
115+
- [React Date Picker](https://coreui.io/react/docs/forms/date-picker/) **PRO**
116+
- [React Date Range Picker](https://coreui.io/react/docs/forms/date-range-picker/) **PRO**
117+
- [React Dropdown](https://coreui.io/react/docs/components/dropdown/)
118+
- [React Floating Labels](https://coreui.io/react/docs/forms/floating-labels/)
119+
- [React Footer](https://coreui.io/react/docs/components/footer/)
120+
- [React Header](https://coreui.io/react/docs/components/header/)
121+
- [React Image](https://coreui.io/react/docs/components/image/)
122+
- [React Input](https://coreui.io/react/docs/forms/input/)
123+
- [React Input Group](https://coreui.io/react/docs/forms/input-group/)
124+
- [React List Group](https://coreui.io/react/docs/components/list-group/)
125+
- [React Loading Button](https://coreui.io/react/docs/components/loading-button/) **PRO**
126+
- [React Modal](https://coreui.io/react/docs/components/modal/)
127+
- [React Multi Select](https://coreui.io/react/docs/forms/multi-select/) **PRO**
128+
- [React Navs & Tabs](https://coreui.io/react/docs/components/navs-tabs/)
129+
- [React Navbar](https://coreui.io/react/docs/components/navbar/)
130+
- [React Offcanvas](https://coreui.io/react/docs/components/offcanvas/)
131+
- [React Pagination](https://coreui.io/react/docs/components/pagination/)
132+
- [React Placeholder](https://coreui.io/react/docs/components/placeholder/)
133+
- [React Popover](https://coreui.io/react/docs/components/popover/)
134+
- [React Progress](https://coreui.io/react/docs/components/progress/)
135+
- [React Radio](https://coreui.io/react/docs/forms/radio/)
136+
- [React Range](https://coreui.io/react/docs/forms/range/)
137+
- [React Select](https://coreui.io/react/docs/forms/select/)
138+
- [React Sidebar](https://coreui.io/react/docs/components/sidebar/)
139+
- [React Smart Pagination](https://coreui.io/react/docs/components/smart-pagination/) **PRO**
140+
- [React Smart Table](https://coreui.io/react/docs/components/smart-table/) **PRO**
141+
- [React Spinner](https://coreui.io/react/docs/components/spinner/)
142+
- [React Switch](https://coreui.io/react/docs/forms/switch/)
143+
- [React Table](https://coreui.io/react/docs/components/table/)
144+
- [React Textarea](https://coreui.io/react/docs/forms/textarea/)
145+
- [React Time Picker](https://coreui.io/react/docs/forms/time-picker/) **PRO**
146+
- [React Toast](https://coreui.io/react/docs/components/toast/)
147+
- [React Tooltip](https://coreui.io/react/docs/components/tooltip/)
148+
97149
## Status
98150

99-
[![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)
100151
[![npm version](https://img.shields.io/npm/v/@coreui/react)](https://www.npmjs.com/package/@coreui/react)
101-
[![peerDependencies Status](https://img.shields.io/david/peer/coreui/coreui)](https://david-dm.org/coreui/coreui?type=peer)
102-
[![devDependency Status](https://img.shields.io/david/dev/coreui/coreui)](https://david-dm.org/coreui/coreui?type=dev)
103-
[![Coverage Status](https://img.shields.io/coveralls/github/coreui/coreui-react/v4)](https://coveralls.io/github/coreui/coreui-react?branch=v4)
104152

105153
## Bugs and feature requests
106154

@@ -117,6 +165,24 @@ The documentation for the CoreUI & CoreUI PRO is hosted at our website [CoreUI f
117165
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.
118166
4. Open `http://localhost:8000/` in your browser, and voilà.
119167

168+
## Frameworks
169+
170+
CoreUI supports most popular frameworks.
171+
172+
- [CoreUI for Angular](https://github.com/coreui/coreui-angular)
173+
- [CoreUI for Bootstrap (Vanilla JS)](https://github.com/coreui/coreui)
174+
- [CoreUI for React](https://github.com/coreui/coreui-react)
175+
- [CoreUI for Vue](https://github.com/coreui/coreui-vue)
176+
177+
## Templates
178+
179+
Fully featured, out-of-the-box, templates for your application based on CoreUI.
180+
181+
- [Angular Admin Template](https://coreui.io/angular)
182+
- [Bootstrap Admin Template](https://coreui.io/)
183+
- [React Admin Template](https://coreui.io/react)
184+
- [Vue Admin Template](https://coreui.io/vue)
185+
120186
## Contributing
121187

122188
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.
@@ -152,6 +218,44 @@ See [the Releases section of our project](https://github.com/coreui/coreui-react
152218

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

221+
## Support CoreUI Development
222+
223+
CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the [CoreUI PRO](https://coreui.io/pricing/) or by becoming a sponsor via [Open Collective](https://opencollective.com/coreui/).
224+
225+
<!--- StartOpenCollectiveBackers -->
226+
227+
### Platinum Sponsors
228+
229+
Support this project by [becoming a Platinum Sponsor](https://opencollective.com/coreui/contribute/platinum-sponsor-40959/). A large company logo will be added here with a link to your website.
230+
231+
<a href="https://opencollective.com/coreui/contribute/platinum-sponsor-40959/checkout"><img src="https://opencollective.com/coreui/tiers/platinum-sponsor/0/avatar.svg?avatarHeight=100"></a>
232+
233+
### Gold Sponsors
234+
235+
Support this project by [becoming a Gold Sponsor](https://opencollective.com/coreui/contribute/gold-sponsor-40960/). A big company logo will be added here with a link to your website.
236+
237+
<a href="https://opencollective.com/coreui/contribute/gold-sponsor-40960/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
238+
239+
### Silver Sponsors
240+
241+
Support this project by [becoming a Silver Sponsor](https://opencollective.com/coreui/contribute/silver-sponsor-40967/). A medium company logo will be added here with a link to your website.
242+
243+
<a href="https://opencollective.com/coreui/contribute/silver-sponsor-40967/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
244+
245+
### Bronze Sponsors
246+
247+
Support this project by [becoming a Bronze Sponsor](https://opencollective.com/coreui/contribute/bronze-sponsor-40966/). The company avatar will show up here with a link to your OpenCollective Profile.
248+
249+
<a href="https://opencollective.com/coreui/contribute/bronze-sponsor-40966/checkout"><img src="https://opencollective.com/coreui/tiers/bronze-sponsor/0/avatar.svg?avatarHeight=100"></a>
250+
251+
### Backers
252+
253+
Thanks to all the backers and sponsors! Support this project by [becoming a backer](https://opencollective.com/coreui/contribute/backer-40965/).
254+
255+
<a href="https://opencollective.com/coreui/contribute/backer-40965/checkout" target="_blank" rel="noopener"><img src="https://opencollective.com/coreui/backers.svg?width=890"></a>
256+
257+
<!--- EndOpenCollectiveBackers -->
258+
155259
## Copyright and license
156260

157-
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/).
261+
Copyright 2022 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/).

0 commit comments

Comments
 (0)
0