README is incomprehensible. #7

Open
sporkmonger opened this Issue May 2, 2012 · 1 comment

2 participants

@sporkmonger

Please use more realistic examples. Foo, bar, baz, qux don't really tell the reader anything. Looks like an interesting project, but I can't actually evaluate its suitability for any purpose without hunting down some other project that's using it because the README was written with meaningless variable names and contrived examples.

@geemus
Owner

They could certainly be better. But I haven't been doing much active work on/for shindo and I'm not sure that is likely to change real soon. I'll try to find some time to improve the documentation though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment