Skip to content

Commit 1d2515c

Browse files
authored
Merge pull request #40 from webpixels/v2-dev
Update README.md
2 parents dcf0ef9 + 7843908 commit 1d2515c

File tree

1 file changed

+9
-25
lines changed

1 file changed

+9
-25
lines changed

README.md

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<p align="center"><a href="https://webpixels.io/start" target="_blank"><img src="https://webpixels.s3.eu-central-1.amazonaws.com/public/github/logo.png" width="200" height=""></a></p>
1+
<p align="center"><a href="https://webpixels.io?ref=github" target="_blank"><img src="https://webpixels.s3.eu-central-1.amazonaws.com/public/github/logo.png" width="200" height=""></a></p>
22

3-
<h3 align="center">Webpixels CSS</h3>
3+
<h3 align="center">Webpixels CSS <sup>2</sup></h3>
44

55
<p align="center">
66
Utility and component-centric Design System based on Bootstrap for fast, responsive UI development.
@@ -17,7 +17,7 @@
1717
<a href="https://webpixels.io/blog/">Blog</a>
1818
</p>
1919

20-
<p align="center"><a href="https://webpixels.io/start" target="_blank"><img src="https://webpixels.s3.eu-central-1.amazonaws.com/public/github/products/css.png" ></a></p>
20+
<p align="center"><a href="https://webpixels.io?ref=github" target="_blank"><img src="https://webpixels.s3.eu-central-1.amazonaws.com/public/github/products/css.png" ></a></p>
2121

2222
## Install via npm
2323

@@ -41,37 +41,21 @@ In your `scss` folder create two new files and name them:
4141
In your main.scss, you’ll import the source Sass files. Bootstrap is automatically loaded when you use the source files, so you don't need to worry about what Bootstrap files should you incorporate in your styles.
4242

4343
```scss
44-
@import "@webpixels/css/base";
45-
@import "@webpixels/css/forms";
44+
// Functions
45+
@import "bootstrap/scss/functions";
4646

47-
// Load all the components
48-
@import "@webpixels/css/components";
47+
// Main
48+
@import "@webpixels/css/main";
4949
```
5050

51-
or pick the parts you need:
52-
53-
```scss
54-
@import "@webpixels/css/base";
55-
@import "@webpixels/css/forms";
56-
57-
// Load only the components you use
58-
@import "@webpixels/css/components/alerts";
59-
@import "@webpixels/css/components/avatars";
60-
@import "@webpixels/css/components/buttons";
61-
@import "@webpixels/css/components/navbars";
62-
@import "@webpixels/css/components/cards";
63-
```
64-
65-
[**Click here**](https://github.com/webpixels/css/blob/master/scss/components/_index.scss) to see the complete list of available components.
66-
6751
### Import the utility classes
6852

6953
In Webpixels CSS you'll notice that we don't create custom styles, but rather make use of the utility classes. We are using the new Bootstrap Utility API to generate a comprehensive list of classes.
7054

7155
In your utility.scss you'll import all the utilities:
7256

7357
```scss
74-
@import "@webpixels/css/utilities";
58+
@import "@webpixels/css/utility";
7559
```
7660

7761
## Documentation
@@ -107,7 +91,7 @@ Get updates on the development of our CSS tool and chat with the project maintai
10791

10892
## Thank you
10993

110-
- [Mark Otto and the Team](https://github.com/twbs/bootstrap)
94+
- [Bootstrap](https://github.com/twbs/bootstrap)
11195

11296
## License
11397

0 commit comments

Comments
 (0)