diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b7ad661 --- /dev/null +++ b/LICENSE @@ -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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ec5088 --- /dev/null +++ b/README.md @@ -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 + + + +``` + +## 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. \ No newline at end of file