Skip to content

Commit

Permalink
Add README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
junjizhi committed Jun 8, 2021
1 parent 79ba579 commit f778348
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016-2020 - BootstrapVue

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.
97 changes: 97 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# bootstrap-vue-timeline

## Introduction
A timeline component similar to [Ant Timeline](https://www.antdv.com/components/timeline/) based on [Bootstrap-Vue](https://bootstrap-vue.org/).

## Demo

Link: TBD

## Usage

```html
<script>
import Vue from 'vue';
import BootstrapVueTimeline from '@/bootstrap-vue-timeline.vue';
import { BCard } from 'bootstrap-vue'
Vue.component('b-card', BCard)
export default Vue.extend({
name: 'ServeDev',
components: {
BootstrapVueTimeline
},
data() {
return {
timelineItems: [
{
timestamp: Date.parse('2021-05-29T20:20:46.444Z'),
title: 'Dolore ullamco exercitation commodo',
content: 'Esse dolore consectetur aliqua laboris sunt aliqua do non.',
link: 'https://example1.com'
},
{
timestamp: Date.parse('2021-05-28T20:20:46.444Z'),
title: 'Voluptate pariatur dolore laborum eu',
link: '#'
},
{
timestamp: Date.parse('2021-01-28T20:20:46.444Z'),
title: 'Mollit aliqua velit nostrud ipsum',
content: 'Magna officia est fugiat sit esse consectetur labore elit nulla duis consectetur. Et sit velit ad ipsum officia.',
link: '#'
}
]
}
}
});
</script>

<template>
<div id="app">
<b-card
title="Event Timeline"
>
<bootstrap-vue-timeline
:items="timelineItems"
/>
</b-card>
</div>
</template>
```

## Features (WIP)
- [ ] Loading spinner
- [ ] Support item head color variants
- [ ] Support `reverse` props
- [ ] Support custom icons
- [ ] Refactor timeline and item into separate components

## Component Reference
### Properties
TBD
### Slots
TBD
### Events
TBD

## Development

**Install dependencies**:
```bash
yarn install --dev
```

**Run example app locally**:
```bash
yarn serve
```

**Lints and fixes files**:
```bash
yarn lint
```

## License

Released under the MIT [License](./LICENSE). Copyright (c) Bootstrap-vue-timeline.

0 comments on commit f778348

Please sign in to comment.