Skip to content

Commit 537c57d

Browse files
author
Pooya Parsa
committed
Update README
1 parent 12db8d2 commit 537c57d

File tree

1 file changed

+80
-40
lines changed

1 file changed

+80
-40
lines changed

‎README.md

Lines changed: 80 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,72 @@
11
# Bootstrap Vue
2-
[Twitter Bootstrap 4](https://v4-alpha.getbootstrap.com/) components for [Vue.js 2](https://vuejs.org/)
32

43
<p align="center">
5-
<img src="https://github.com/bootstrap-vue/bootstrap-vue/raw/master/banner.png" width="200px">
4+
<a href="https://bootstrap-vue.github.io">
5+
<img src="https://github.com/bootstrap-vue/bootstrap-vue/raw/master/banner.png" width="200px">
6+
</a>
67
<br>
7-
<img alt="" src="https://img.shields.io/circleci/project/github/bootstrap-vue/bootstrap-vue/master.svg">
8-
<img alt="" src="https://img.shields.io/npm/dt/bootstrap-vue.svg">
9-
<img alt="" src="https://img.shields.io/npm/v/bootstrap-vue.svg">
10-
<img alt="" src="https://img.shields.io/badge/code_style-XO-5ed9c7.svg">
11-
<a href="https://www.codacy.com/app/pi0/bootstrap-vue?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=bootstrap-vue/bootstrap-vue&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/efdefff98c8848a9b6038b164f10acc6"/></a>
12-
<img alt="" src="https://img.shields.io/badge/bootstrap-4.0.0--alpha.6-800080.svg">
13-
<img alt="" src="https://img.shields.io/badge/vue.js-2.2.x-green.svg">
8+
<a href="https://circleci.com/gh/bootstrap-vue/bootstrap-vue">
9+
<img alt="" src="https://img.shields.io/circleci/project/github/bootstrap-vue/bootstrap-vue/master.svg">
10+
</a>
11+
<a href="https://www.npmjs.com/package/bootstrap-vue">
12+
<img alt="" src="https://img.shields.io/npm/dt/bootstrap-vue.svg">
13+
</a>
14+
<a href="https://www.npmjs.com/package/bootstrap-vue">
15+
<img alt="" src="https://img.shields.io/npm/v/bootstrap-vue.svg">
16+
</a>
17+
<a href="https://github.com/sindresorhus/xo">
18+
<img alt="" src="https://img.shields.io/badge/code_style-XO-5ed9c7.svg">
19+
</a>
20+
<a href="https://v4-alpha.getbootstrap.com">
21+
<img alt="" src="https://img.shields.io/badge/bootstrap-4.0.0--alpha.6-800080.svg">
22+
</a>
23+
<a href="https://vuejs.org">
24+
<img alt="" src="https://img.shields.io/badge/vue.js-2.2.x-green.svg">
25+
</a>
26+
<a href="https://www.codacy.com/app/pi0/bootstrap-vue?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=bootstrap-vue/bootstrap-vue&amp;utm_campaign=Badge_Grade">
27+
<img src="https://api.codacy.com/project/badge/Grade/efdefff98c8848a9b6038b164f10acc6"/>
28+
</a>
1429
</p>
1530

31+
> [Bootstrap 4](https://v4-alpha.getbootstrap.com/) components for [Vue 2](https://vuejs.org/)
32+
1633
# Getting started
1734
Please head to [Official Docs Website](https://bootstrap-vue.github.io) for setup guide, examples and documentation.
1835

19-
# Current included stable components
36+
**NPM**
37+
38+
Get it via your favorite package manager:
39+
```bash
40+
$ npm i bootstrap-vue@latest
41+
# OR
42+
$ yarn add bootstrap-vue@latest
43+
```
44+
45+
Register components:
46+
```js
47+
import Vue from 'vue'
48+
import BootstrapVue from 'bootstrap-vue';
49+
50+
// Globally register bootstrap-vue components
51+
Vue.use(BootstrapVue);
52+
```
53+
54+
**CDN**
55+
56+
Simply include js inside your HTML templates,(free CDN from Powered by unpkg)
57+
```html
58+
<script src="https://unpkg.com/bootstrap-vue/dist/bootstrap-vue.js"></script>
59+
```
2060

21-
- [Alerts](https://bootstrap-vue.github.io/docs/components/alerts) **New features**
61+
**Nuxt.js**
62+
63+
If you are using [nuxt.js](github.com/nuxt/nuxt.js), you can register bootstrap-vue components using [nuxt helpers](https://github.com/fandogh/nuxt-helpers).
64+
65+
# Supported components
66+
67+
**Stable**
68+
69+
- [Alerts](https://bootstrap-vue.github.io/docs/components/alerts)
2270
- [Breadcrumb](https://bootstrap-vue.github.io/docs/components/breadcrumb)
2371
- [Buttons](https://bootstrap-vue.github.io/docs/components/buttons)
2472
- [Button group](https://bootstrap-vue.github.io/docs/components/button-group)
@@ -28,36 +76,28 @@ Please head to [Official Docs Website](https://bootstrap-vue.github.io) for setu
2876
- [Form Checkbox](https://bootstrap-vue.github.io/docs/components/form-checkbox)
2977
- [Form Select](https://bootstrap-vue.github.io/docs/components/form-select)
3078
- [Nav](https://bootstrap-vue.github.io/docs/components/nav)
31-
- [NavBar](https://bootstrap-vue.github.io/docs/components/navbar) **New features**
79+
- [NavBar](https://bootstrap-vue.github.io/docs/components/navbar)
3280
- [Pagination](https://bootstrap-vue.github.io/docs/components/pagination)
33-
- [Popover](https://bootstrap-vue.github.io/docs/components/popover) **New features**
34-
- [Tables](https://bootstrap-vue.github.io/docs/components/tables) **New features**
81+
- [Popover](https://bootstrap-vue.github.io/docs/components/popover)
82+
- [Tables](https://bootstrap-vue.github.io/docs/components/tables)
83+
84+
**Under development**
3585

36-
Additionally, [many more components](https://github.com/bootstrap-vue/bootstrap-vue/tree/master/components) are available, but they are still under development. If you really need to use them, feel free to experiment and submit pull requests to benefit other users of this package.
86+
Additionally, [many more components](https://github.com/bootstrap-vue/bootstrap-vue/tree/master/components) are available and working, but they are still under development.
87+
88+
- [Modals](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/modal.vue)
89+
- [Badge](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/badge.vue)
90+
- [Card](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/card.vue)
91+
- [Carousel](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/carousel.vue)
92+
- [Jumbotrons](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/carousel.vue)
93+
- [Media](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/media.vue)
94+
- [Progress](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/progress.vue)
95+
- [Tab](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/tab.vue)
96+
- [Tabs](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/tabs.vue)
97+
- [Tooltip](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/components/tooltip.vue)
3798

38-
# Supported versions
39-
Both Vue v2 and Bootstrap v4 are changing so fast, specifically Bootstrap 4 is still in *alpha* stage.
40-
We do our best to stay up-to-date with the latest changes. Latest supported versions are indicated in badges on top of this page.
41-
42-
4399
# License
44-
The MIT License (MIT)
45-
Copyright (c) 2016 Pooya Parsa
46-
47-
Permission is hereby granted, free of charge, to any person obtaining a copy
48-
of this software and associated documentation files (the "Software"), to deal
49-
in the Software without restriction, including without limitation the rights
50-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
51-
copies of the Software, and to permit persons to whom the Software is
52-
furnished to do so, subject to the following conditions:
53-
54-
The above copyright notice and this permission notice shall be included in all
55-
copies or substantial portions of the Software.
56-
57-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
58-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
59-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
60-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
61-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
62-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
63-
SOFTWARE.
100+
The MIT License (MIT) - Copyright (c) 2016-present Pooya Parsa.
101+
Designed and built with all the love in the world.
102+
Maintained by the [core team](https://github.com/orgs/bootstrap-vue/people) with the help of our contributors.
103+
Documentation is generated using [Nuxt.js](https://nuxtjs.org)

0 commit comments

Comments
 (0)