Browse Source

add usage page in getting started guide,
add readme npm and CDN installation guide

Michal Wolny 4 years ago
parent
commit
dde02732ef

+ 16 - 0
README.md

@@ -73,6 +73,22 @@ Once you complete the setup, you'll be able to run the various commands provided
 Run `npm run build` for reforms a one off build application without refresh.
 Open [http://localhost:3001](http://localhost:3001) to configure the Web server.
 
+## Installation
+
+Tabler is distributed via npm.
+
+```sh
+npm install --save @tabler/core
+```
+
+### CDN support
+
+All files included in `@tabler/core` npm package are available over a CDN.
+
+```html
+<link rel="stylesheet" href="https://unpkg.com/@tabler/core@latest/dist/css/tabler.min.css">
+<script src="https://unpkg.com/@tabler/core@latest/dist/js/tabler.min.js"></script>
+```
 
 ## Feature requests
 

+ 5 - 0
demo/changelog.html

@@ -343,6 +343,11 @@
                         Introduction
                       </a>
                     </li>
+                    <li class="nav-item">
+                      <a href="./docs/usage.html" class="nav-link">
+                        Usage
+                      </a>
+                    </li>
                     <li class="nav-item">
                       <a href="./docs/colors.html" class="nav-link">
                         Colors

+ 5 - 0
demo/docs/alerts.html

@@ -343,6 +343,11 @@
                         Introduction
                       </a>
                     </li>
+                    <li class="nav-item">
+                      <a href="../docs/usage.html" class="nav-link">
+                        Usage
+                      </a>
+                    </li>
                     <li class="nav-item">
                       <a href="../docs/colors.html" class="nav-link">
                         Colors

+ 5 - 0
demo/docs/autosize.html

@@ -343,6 +343,11 @@
                         Introduction
                       </a>
                     </li>
+                    <li class="nav-item">
+                      <a href="../docs/usage.html" class="nav-link">
+                        Usage
+                      </a>
+                    </li>
                     <li class="nav-item">
                       <a href="../docs/colors.html" class="nav-link">
                         Colors

+ 5 - 0
demo/docs/avatars.html

@@ -343,6 +343,11 @@
                         Introduction
                       </a>
                     </li>
+                    <li class="nav-item">
+                      <a href="../docs/usage.html" class="nav-link">
+                        Usage
+                      </a>
+                    </li>
                     <li class="nav-item">
                       <a href="../docs/colors.html" class="nav-link">
                         Colors

+ 5 - 0
demo/docs/badges.html

@@ -343,6 +343,11 @@
                         Introduction
                       </a>
                     </li>
+                    <li class="nav-item">
+                      <a href="../docs/usage.html" class="nav-link">
+                        Usage
+                      </a>
+                    </li>
                     <li class="nav-item">
                       <a href="../docs/colors.html" class="nav-link">
                         Colors

+ 5 - 0
demo/docs/breadcrumb.html

@@ -343,6 +343,11 @@
                         Introduction
                       </a>
                     </li>
+                    <li class="nav-item">
+                      <a href="../docs/usage.html" class="nav-link">
+                        Usage
+                      </a>
+                    </li>
                     <li class="nav-item">
                       <a href="../docs/colors.html" class="nav-link">
                         Colors

+ 5 - 0
demo/docs/buttons.html

@@ -343,6 +343,11 @@
                         Introduction
                       </a>
                     </li>
+                    <li class="nav-item">
+                      <a href="../docs/usage.html" class="nav-link">
+                        Usage
+                      </a>
+                    </li>
                     <li class="nav-item">
                       <a href="../docs/colors.html" class="nav-link">
                         Colors

+ 5 - 0
demo/docs/cards.html

@@ -343,6 +343,11 @@
                         Introduction
                       </a>
                     </li>
+                    <li class="nav-item">
+                      <a href="../docs/usage.html" class="nav-link">
+                        Usage
+                      </a>
+                    </li>
                     <li class="nav-item">
                       <a href="../docs/colors.html" class="nav-link">
                         Colors

+ 5 - 0
demo/docs/carousel.html

@@ -343,6 +343,11 @@
                         Introduction
                       </a>
                     </li>
+                    <li class="nav-item">
+                      <a href="../docs/usage.html" class="nav-link">
+                        Usage
+                      </a>
+                    </li>
                     <li class="nav-item">
                       <a href="../docs/colors.html" class="nav-link">
                         Colors

Some files were not shown because too many files changed in this diff