Skip to content

Commit 807ae4c

Browse files
committed
feat: instalation section
1 parent df4c45c commit 807ae4c

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,34 @@ In the repository you will find the following directories:
3333

3434
We provide compiled CSS (`metro-bootstrap.css`) in the dist folder, as well as compiled and minified CSS (`metro-bootstrap.min.css`).
3535

36+
## Installation
37+
38+
You can install and use `metro-bootstrap` in your project using either a **Git clone** or a **CDN**.
39+
40+
### 1. Using Git Clone
41+
42+
To clone the repository and include `metro-bootstrap`:
43+
44+
```bash
45+
git clone https://github.com/TalksLab/metro-bootstrap.git
46+
```
47+
48+
After cloning, you can directly link the CSS files located in the `dist/css/` directory in your HTML:
49+
50+
```html
51+
<link rel="stylesheet" href="path/to/metro-bootstrap/dist/css/metro-bootstrap.min.css">
52+
```
53+
54+
### 2. Using a CDN
55+
56+
You can include the `metro-bootstrap` CSS directly from a CDN for ease of use. Add the following line in your HTML `<head>`:
57+
58+
```html
59+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/TalksLab/metro-bootstrap@master/dist/css/metro-bootstrap.min.css">
60+
```
61+
62+
This will pull the latest compiled and minified CSS directly from the repository.
63+
3664
## Installing Dependencies
3765

3866
We manage dependencies using npm.

0 commit comments

Comments
 (0)