First release

Author: ycs77

.gitignore

@@ -1 +1,2 @@
-node_modules
+/node_modules
+yarn-error.log

.npmignore

@@ -0,0 +1,3 @@
+/docs
+/scripts
+/src

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2019 Lucas Yang <yangchenshin77@gmail.com>
+
+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.

README.md

@@ -1,9 +1,68 @@
-# Bootstrap 4 Steps
+# Bootstrap Steps
 
 [![npm version](https://badge.fury.io/js/bootstrap-steps.svg)](https://badge.fury.io/js/bootstrap-steps)
 
-A simple Bootstrap 4 steps plugin, support mobile client.
+A simple Bootstrap steps plugin, support mobile client.
 
-## Example
+## Demo
 
-https://ycs77.github.io/bootstrap-steps/
+See [Demo](https://ycs77.github.io/bootstrap-steps/).
+
+## Getting started
+
+Must include [Bootstrap](https://getbootstrap.com/).
+
+### Installation
+
+```
+$ npm install bootstrap-steps
+```
+or
+```
+$ yarn add bootstrap-steps
+```
+
+*bootstrap.scss*
+```
+...
+@import "~bootstrap-steps/scss/bootstrap-steps";
+```
+
+In browser:
+```html
+<link  href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet"><!-- Bootstrap is required -->
+<link  href="/path/to/bootstrap-steps.css" rel="stylesheet">
+```
+
+### Usage
+
+```html
+<div class="steps-scroll">
+  <ul class="steps">
+    <li class="step step-success">
+      <div class="step-content">
+        <span class="step-circle">1</span>
+        <span class="step-text">Step 1</span>
+      </div>
+    </li>
+    <li class="step step-active">
+      <div class="step-content">
+        <span class="step-circle">2</span>
+        <span class="step-text">Step 2</span>
+      </div>
+    </li>
+    <li class="step">
+      <div class="step-content">
+        <span class="step-circle">3</span>
+        <span class="step-text">Step 3</span>
+      </div>
+    </li>
+    <li class="step">
+      <div class="step-content">
+        <span class="step-circle">4</span>
+        <span class="step-text">Step 4</span>
+      </div>
+    </li>
+  </ul>
+</div>
+```