-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Tidied up readme.md ready for release
- Loading branch information
1 parent
baf870b
commit 3447c2c
Showing
5 changed files
with
43 additions
and
24 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,28 @@ | ||
# Milligrid | ||
# Milligrid: | ||
|
||
Milligrid is a CSS grid system build using flexbox and Sass. You can view it in action [here](http://bencoveney.github.io/Milligrid). It is based on the [milligram](https://github.com/milligram/milligram) library. | ||
Milligrid is a responsive CSS grid system which uses flexbox as a basis for its layout. It is based on the excellent grid built into [Milligram](https://milligram.github.io), which was in turn based on work by [Philip Walton](http://philipwalton.github.io/solved-by-flexbox/demos/grids/). Milligrid aims to take the brilliant Milligram grid and provide it in a standalone package with enhanced configuration options in the form of Sass variables. | ||
|
||
## Planned features: | ||
[Complete documentation](http://bencoveney.github.io/Milligrid/) is available for information on how best to utilise the grid system. | ||
|
||
## Versions | ||
|
||
### Milligrid.css | ||
The core of Milligrid, this stylesheet includes only the grid styling with the default options. | ||
|
||
### MilligridExtended.css - Incomplete! | ||
Includes the core Milligram grid system and some additional text styling options. This is under development and should be used with caution. | ||
|
||
+ Additional text element styles. | ||
+ Configurable vertical flow. | ||
+ Publish of package to bower (and other) platforms. | ||
### *.scss | ||
The .scss Sass source code files. These can be configured using the variables or ripped up and re-used however best suits your needs. | ||
|
||
## Release History: | ||
|
||
### v1.0.0 - 20/02/2016 | ||
+ Initial release. | ||
+ Complete grid system. | ||
+ Very basic text styling. | ||
|
||
## Planned features: | ||
+ Responsive utility classes (lg, md, sm, xs). | ||
+ A More complete set of text element styles. | ||
+ Configurable vertical rhythm. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters