Skip to content

Commit 419a3b1

Browse files
authored
Update README.md
1 parent a87e895 commit 419a3b1

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,49 @@
11
# [Material Design Bootstrap Web Components | FREE](https://www.htmlelements.com)[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Get%20over%2020%20free%20custom%20elements%20based%20on%20SmartHTMLElements%20&url=https://www.htmlelements.com/&via=htmlelements&hashtags=bootstrap,design,templates,autocomplete,bootstrap-components,typeahead,developers,webcomponents,customelements,polymer,material)
22

3-
[Installation ↗](https://www.npmjs.com/package/smart-bootstrap)
3+
## Installation
4+
5+
```javascript
6+
npm install @smarthtmlelemnets/smart-core
7+
```
8+
9+
## CSS
10+
11+
Copy-paste the stylesheet <link> into your <head> before all other stylesheets to load our CSS.
12+
13+
```html
14+
<link rel="stylesheet" href="src/styles/smart.bootstrap.css">
15+
```
16+
17+
or
18+
19+
```html
20+
import 'src/styles/smart.bootstrap.css';
21+
```
22+
23+
## Javascript
24+
25+
```html
26+
<script src="src/smart.element.js"></script>
27+
<script src="src/smart.bootstrap.js"></script>
28+
```
29+
30+
or
31+
32+
```html
33+
import 'src/smart.element.js'
34+
import 'src/smart.bootstrap.js'
35+
```
36+
37+
38+
## Overview
439

540
The package extends Bootstrap by adding Material Design and CSS3 Variables for Styling.
641

742
The Boostrap components are rewritten from scratch and are built as Web Components by using the ```Smart Framework```.
843

944
The Bootstrap SCSS is rewritten with CSS3 Variables and Material Design is added.
1045

46+
## Components
1147

1248
![Material Design Bootstrap](https://github.com/HTMLElements/MBWC-Toolkit/blob/master/images/bootstrap.png)
1349

0 commit comments

Comments
 (0)