Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
STRML committed Dec 28, 2014
1 parent 79acf4b commit 8eb26e2
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
### React-Grid-Layout

Project is a WIP and not suitable yet for use.
[View the Demo](https://strml.github.io/react-grid-layout/example.html)

React-Grid-Layout is a grid layout system much like [Packery](http://packery.metafizzy.co/) or
[Gridster](http://gridster.net), for React.

RGL is not as full-featured as the above projects. However, it solves a major pain point I've found with those
projects - it is responsive! Try resizing the window in the demo and see how the grid resizes without any fuss.

RGL is React-only and does not require jQuery. It does (for the time being) require lodash.

More demos are coming soon. RGL supports adding and removing components without fuss.

If you have a feature request, add it as an issue.

----

#### TODO List

[x] Basic grid layout
[x] Fluid grid layout
[x] Grid packing
[x] Draggable grid items
[x] Live grid packing while dragging
[ ] Define grid attributes on children themselves (`_grid` key)
[ ] Resizable grid items
2 changes: 1 addition & 1 deletion webpack.config.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module.exports = {
context: __dirname,
entry: [
"./index",
"./test/test.js",
],
output: {
path: __dirname + "/dist",
Expand Down

0 comments on commit 8eb26e2

Please sign in to comment.