Need better docs/examples

[hilary-L]

I really like the idea of this project -- I think there's a lot of room for making animation in react simpler. However, I think you need better documentation / examples. I tried using this in a project I'm working on today and for the life of me I couldn't get it working. The cloned repo and example worked fine -- but when I tried to apply it to my own code... well, nothing worked.

It'd be nice if you had some examples showing animation of components that weren't the included Rect, and also if you specified what css is required on custom components to make everything play nicely.

[jondot]

Hi Hilary,

Super excited you're trying this out! too bad it doesn't work on your own code - I would love to see what kind of errors / mishaps you're having.

Needless to say, react-flight serves my own projects and few others - I open sourced it so that people could cut down their rampup times doing animations in this fashion.

I didn't expect it to become so popular overnight, so more extensive documentation was pushed back. Now that everything is out, I'm working on an API documentation, which will soon be up. I'll make sure I have a section for custom components.

[briannhinton]

Any updates on docs?