From d8d6d21f55540803a628da3bedfed3bce467894c Mon Sep 17 00:00:00 2001 From: Jingshao Chen Date: Sat, 29 Jan 2022 13:19:44 +0800 Subject: [PATCH] Readme --- README.md | 19 +++++++++++++++---- package.json | 2 +- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4c191a3..bee67e7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ A customizable step component written in Svelte! +- [x] Bootstrap color theme +- [x] Icons +- [x] Horizontal and vertical +- [x] Dumpbells and bar +- [x] Custom size +- [x] Custom color +- [x] Custom font +- [x] Circle, square and between +- [x] Left and right + + ![demo](static/demo.png) ## Installation @@ -12,7 +23,7 @@ npm install --saveDev svelte-steps ## Example Usages -Clone this project and run it. Itself is an example. Take a look at the homepage [here](https://svelte-steps.web.app) +Clone this project and run it. Itself is an example. Take a look at the homepage [here](https://svelte-steps.web.app). And the source file is at [src/routes/index.svelte](src/routes/index.svelte) ### Basic Usage @@ -71,7 +82,7 @@ let steps = [ ### Custom Size ```javascript - + ``` ### No Text @@ -87,7 +98,7 @@ let steps = [ ### Bar ```javascript - ``` ### Events @@ -139,6 +150,6 @@ It by default uses `--bs-primary`, `--bs-secondary`, `--bs-light`, and `--bs-dar ## Events -- `on:click(e)`: click event with arg as the clicked step index as `e.detail.current` and last step index as `e.detail.last` +- `on:click(e)`: click event. The clicked step index is `e.detail.current` and the last step index is `e.detail.last` diff --git a/package.json b/package.json index 4a25d42..cf4523a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "svelte-steps", - "version": "2.0.0", + "version": "2.0.1", "description": "A customizable step component written in Svelte", "repository": { "type": "git",