Skip to content

Commit 7011b9e

Browse files
none: updated readme, deployed
1 parent e22684c commit 7011b9e

File tree

2 files changed

+827
-752
lines changed

2 files changed

+827
-752
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55

66
A react implementation of the [Super Simple Flex Grid]
77

8-
**[Demo]**
8+
### What the grid is
9+
- An HTML centric approach to Flexbox, with emphasis on customizability through props.
910

10-
**[NPM]**
11+
### What the grid is not
12+
- Viewport-specific responsive: In the real world, design often requires pixel perfect implementation. Having responsive styles dictated in HTML through [viewport]-[grow1/grow2/hide/show] classes as well as custom css is a pain and hassle to maintain. With this grid system, all responsive behavior is handled with custom CSS.
1113

12-
**[Github]**
14+
**[Demo]** | **[NPM]** | **[Github]**
1315

1416
### Installing
1517
```sh
@@ -63,7 +65,7 @@ const FlexGridExample = () => (
6365
| [ellipsis] | `bool` | ellipse text | `overflow: hidden` **[^1]** |
6466

6567
**[^1]** Ellipsis prop also adds a child `div` that contains the following CSS:
66-
```scss
68+
```css
6769
white-space: nowrap;
6870
overflow: hidden;
6971
text-overflow: ellipsis;
@@ -89,6 +91,15 @@ Super-simple-flex-grid-react uses a number of open source projects:
8991
$ npm test
9092
```
9193

94+
### To do
95+
* Rename FlexRow and FlexCell components to Row and Col
96+
* Use CSS Modules
97+
* Create Codepen example
98+
* Add Karma and get rid of test classes
99+
* Add outstanding tests
100+
* Configure Travis to push to Github
101+
* Remove unnecessary props, such as startH and startV
102+
92103
License
93104
----
94105

0 commit comments

Comments
 (0)