Skip to content

Commit

Permalink
Refactor build logic; Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
junjizhi committed Jun 9, 2021
1 parent dd99fc2 commit d824d6d
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 7 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
## Introduction
A simple timeline component similar to [Ant Timeline](https://www.antdv.com/components/timeline/) based on [Bootstrap-Vue](https://bootstrap-vue.org/).

**Note**: This component assumes you use [Bootstrap-Vue (v4)](https://bootstrap-vue.org/) in your project and have installed [the dependencies](https://bootstrap-vue.org/docs).

## Demo

Link: TBD
Expand All @@ -12,7 +14,8 @@ Link: TBD
```bash
npm i bootstrap-vue-timeline

# or:
# if you use yarn:

yarn add bootstrap-vue-timeline
```

Expand All @@ -21,9 +24,17 @@ yarn add bootstrap-vue-timeline
```html
<script>
import Vue from 'vue';
import BootstrapVueTimeline from '@/bootstrap-vue-timeline.vue';
import BootstrapVueTimeline from 'bootstrap-vue-timeline'
import { BCard } from 'bootstrap-vue'
Vue.component('b-card', BCard)
Vue.component('b-timeline', BootstrapVueTimeline)
// Uncomment the following to import BootstrapVue CSS files if you
// have not done so when registering BootstrapVue. Order is important.
// Check out: https://bootstrap-vue.org/docs#using-module-bundlers
// import 'bootstrap/dist/css/bootstrap.min.css'
// import 'bootstrap-vue/dist/bootstrap-vue.css'
export default Vue.extend({
name: 'ServeDev',
Expand Down Expand Up @@ -61,7 +72,7 @@ export default Vue.extend({
<b-card
title="Event Timeline"
>
<bootstrap-vue-timeline
<b-timeline
:items="timelineItems"
/>
</b-card>
Expand Down Expand Up @@ -91,6 +102,11 @@ TBD
yarn install --dev
```

**Build component**:
```bash
yarn build
```

**Run example app locally**:
```bash
yarn serve
Expand Down
3 changes: 3 additions & 0 deletions dev/serve.vue
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import BootstrapVueTimeline from '@/bootstrap-vue-timeline.vue';
import { BCard } from 'bootstrap-vue'
Vue.component('b-card', BCard)
import 'bootstrap/dist/css/bootstrap.min.css'
import 'bootstrap-vue/dist/bootstrap-vue.css'
export default Vue.extend({
name: 'ServeDev',
components: {
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@
},
"standard": {
"ignore": [
"*.config.js"
"*.config.js",
"dist/"
]
}
}
3 changes: 0 additions & 3 deletions src/bootstrap-vue-timeline.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ Vue.component('b-list-group', BListGroup)
Vue.component('b-list-group-item', BListGroupItem)
Vue.component('b-tooltip', BTooltip)
import 'bootstrap/dist/css/bootstrap.min.css'
import 'bootstrap-vue/dist/bootstrap-vue.css'
export default /*#__PURE__*/{
name: 'BootstrapVueTimeline', // vue component name
props: {
Expand Down

0 comments on commit d824d6d

Please sign in to comment.