diff --git a/README.md b/README.md index 1803667..0e8777f 100644 --- a/README.md +++ b/README.md @@ -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 @@ -12,7 +14,8 @@ Link: TBD ```bash npm i bootstrap-vue-timeline -# or: +# if you use yarn: + yarn add bootstrap-vue-timeline ``` @@ -21,9 +24,17 @@ yarn add bootstrap-vue-timeline ```html