update readme

Author: rismanss

.github/workflows/gh-pages.yml

@@ -1,7 +1,8 @@
 name: Build and Deploy
-on: [push]
- # push:
- # paths: ["template/**", ".storybook/**"] # Trigger the action only when files change in the folders defined here
+# on: [push]
+on:
+ push:
+ paths: ["template/**", ".storybook/**"] # Trigger the action only when files change in the folders defined here
 jobs:
  build-and-deploy:
  runs-on: ubuntu-20.04

readme.md

@@ -2,12 +2,15 @@
 
 > CLI for create uikit in react project suport with storybook
 
-## Features
-- [x] Easy-to-use CLI
-- [x] free modify uikit
-- [x] support with storybook
-- [ ] support with unit test
+## Table of Contents
+- [Getting Started](#getting-started)
+- [Features](#features)
+- [UIkit List Available](https://rismanss.github.io/react-uikit-cli/)
+- [Button](https://rismanss.github.io/react-uikit-cli/?path=/docs/button--example)
+- [Input](https://rismanss.github.io/react-uikit-cli/?path=/docs/input--example)
+- [Switch](https://rismanss.github.io/react-uikit-cli/?path=/docs/switch--example)
 
+## Getting started
 ### Install globally
 ```
 npm install -g react-uikit-cli
@@ -44,5 +47,8 @@ Commands:
  start:sb run watch storybook
 ```
 
-## Documentation
--
+## Features
+- [x] Easy-to-use CLI
+- [x] free modify uikit
+- [x] support with storybook
+- [ ] support with unit test