Edit readme

Author: jxnblk

.travis.yml

@@ -1,3 +1,3 @@
 language: node_js
 node_js:
-  - 6.2
+  - 8

LICENSE.md

@@ -0,0 +1,10 @@
+
+# The MIT License (MIT)
+Copyright (c) 2017 Brent Jackson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

README.md

@@ -1,7 +1,7 @@
 
 # React CSS Grid
 
-React layout component based on [CSS Grid Layout][spec]
+React layout component based on [CSS Grid Layout][spec] ([Demo][demo])
 
 [![Build Status][travis-badge]][travis]
 
@@ -33,10 +33,35 @@ class App extends React.Component {
 }
 ```
 
+
 ## Features
 
-- Simple, encapsulated grid layout API
+- Responsive grid layout with zero media queries
+- Simple API for handling tiled layouts
+- Customizable column width and gutters
+
+
+## Props
+
+- `width` (number or string) width at which child elements will break into columns - either a number pixel value or any valid CSS width value as a string
+- `gap` (number or string) gutter (`grid-gap`) between columns - either a number pixel value or any valid CSS width value as a string
+
+
+## Browser Support
+
+See http://caniuse.com/#feat=css-grid
+
+## Related
+
+- [Grid Styled](https://github.com/jxnblk/grid-styled)
+- [styled-components](https://github.com/styled-components/styled-components)
+- [CSS Grid Layout Module][spec]
+- [CSS Grid Layout on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout)
+- [Grid by Example](https://gridbyexample.com/video/series-auto-fill-auto-fit/)
+- [Spring Into CSS Grid](http://jonibologna.com/spring-into-css-grid/)
+
 
 [spec]: https://www.w3.org/TR/css-grid-1/
+[demo]: http://jxnblk.com/react-css-grid/
 
-MIT License
+[MIT License](LICENSE.md)

src/index.js

@@ -7,30 +7,30 @@ const width = props => ({
   gridTemplateColumns: `repeat(auto-fit, minmax(${px(props.width)}, 1fr))`
 })
 
-const gutter = props => ({
-  gridGap: px(props.gutter)
+const gap = props => ({
+  gridGap: px(props.gap)
 })
 
 const Grid = styled.div`
   display: grid;
   ${width}
-  ${gutter}
+  ${gap}
 `
 
 Grid.propTypes = {
   width: PropTypes.oneOfType([
     PropTypes.number,
     PropTypes.string
   ]).isRequired,
-  gutter: PropTypes.oneOfType([
+  gap: PropTypes.oneOfType([
     PropTypes.number,
     PropTypes.string
   ]).isRequired
 }
 
 Grid.defaultProps = {
   width: 256,
-  gutter: 32
+  gap: 32
 }
 
 export default Grid

test.js

@@ -18,12 +18,12 @@ test('renders with string width prop', t => {
   t.snapshot(a)
 })
 
-test('renders with gutter prop', t => {
-  const a = render(<Grid gutter={16} />).toJSON()
+test('renders with gap prop', t => {
+  const a = render(<Grid gap={16} />).toJSON()
   t.snapshot(a)
 })
 
-test('renders with string gutter prop', t => {
-  const a = render(<Grid gutter='1em' />).toJSON()
+test('renders with string gap prop', t => {
+  const a = render(<Grid gap='1em' />).toJSON()
   t.snapshot(a)
 })

test.js.md

@@ -47,4 +47,22 @@ Generated by [AVA](https://ava.li).
     <div
       className="sc-bdVaJa eMRWET"
       width={320}
+    /
+
+## renders with gap prop
+
+> Snapshot 1
+
+    <div
+      className="sc-bdVaJa hMURNT"
+      width={256}
     />
+
+## renders with string gap prop
+
+> Snapshot 1
+
+    <div
+      className="sc-bdVaJa hBZALA"
+      width={256}
+    />