Skip to content

Commit 88cb358

Browse files
committed
update readme
1 parent 94b23ce commit 88cb358

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
11
# Material
22

3-
Daemonite's Material UI is a cross-platform and fully responsive front-end interface based on __Google Material Design__. This lightweight framework is built using __Bootstrap 4__.
3+
Daemonite's Material UI is a cross-platform and fully responsive front-end interface based on __Google Material Design__. This lightweight framework is built using __Bootstrap 4__. The basic idea behind this project is to combine the visual language of Google Material Design with the front-end technology of the popular Bootstrap framework.
44

55
> A visual language for our users that synthesizes the classic principles of good design with the innovation and possibility of technology and science. This is material design.
66
> http://www.google.com/design/spec/material-design/introduction.html
77
8-
Let us know what you think at the [Daemon Labs](http://labs.daemon.com.au) forum.
8+
Detailed [documentation site](http://daemonite.github.io/material/) is work in progress. Let us know what you think at the [Daemon Labs](http://labs.daemon.com.au) forum.
9+
10+
## Goals
11+
12+
### Primary
13+
14+
The primary goal of this project is to give all Bootstrap components and elements a Material Design look, so it allows web developers to continue using the exact same Bootstrap HTML markup they are familiar with, but presents a final outcome that is in line with the principles and specifics of Google Material Design.
15+
16+
Therefore, the Bootstrap's [documentation](https://v4-alpha.getbootstrap.com/getting-started/introduction/) can serve as a valid documentation for this project as well. Replacing `bootstrap.min.css` on the site with `material.min.css` from this project without any other changes will transform all components and elements into a materialised look.
17+
18+
### Secondary
19+
20+
A secondary goal of this project is to add support of some unique Material Design components such as floating action buttons, pickers and steppers to name a few, which cannot be achieved by transforming existing Bootstrap components or elements.
21+
22+
Because these components will require additional markup (some may require additional JavaScript), they will be documented separately in Material's documentation (work-in-progress).
923

1024
## Supported Bootstrap 4 Components
1125

26+
Currently based on __Bootstrap v4.0.0-alpha.4__.
27+
1228
| Bootstrap 4 Components | Equivalent Material Design Components |
1329
| --- | --- |
1430
| Alerts | _None, but supported with our own interpretation_ |

0 commit comments

Comments
 (0)