Skip to content

Commit

Permalink
More README update
Browse files Browse the repository at this point in the history
  • Loading branch information
junjizhi committed Jun 9, 2021
1 parent f778348 commit dd99fc2
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# 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/).
A simple timeline component similar to [Ant Timeline](https://www.antdv.com/components/timeline/) based on [Bootstrap-Vue](https://bootstrap-vue.org/).

## Demo

Link: TBD

## Installation

```bash
npm i bootstrap-vue-timeline

# or:
yarn add bootstrap-vue-timeline
```

## Usage

```html
Expand Down Expand Up @@ -60,7 +69,7 @@ export default Vue.extend({
</template>
```

## Features (WIP)
## Features
- [ ] Loading spinner
- [ ] Support item head color variants
- [ ] Support `reverse` props
Expand Down

0 comments on commit dd99fc2

Please sign in to comment.