Update README

[crisptrutski]

1. Can give a better summary of commands, noting the bases cases and naming conventions.
2. Link to examples.

[crisptrutski]

Next steps:

1. Serialization: improve presentation of this,
   • Table with type, how it's stored, and column describing how data degrades
   • Move wall-of-text below it to sub document, or trim it down
2. Provide "10 sec" example
   • Line item so I can tick it
3. Improve "5 min" example:
   • put on separate page
   • break up from one massive code block
   • provide better observer than prn (perhaps go straight to syncing with an atom)
4. Provide overview of wider functionality:
   • show navigation back from child to parent, or connecting directly to a path
   • covered auth cases
   • going online-offline and setting triggers So niche
   • listen-children
   • channel variants of setters, getters and observers
   • closing channels / disabling callbacks
   • setting log level (JVM only)
5. Provide note about contributing Not much to say and didn't find any appealing boilerplate.
6. Branding
   • Add a logo
   • Simplify tagline
7. Keep README in easy-to-execute form (tangle? something like readme-midje for non-midge?),
   preferably run by Travis

[leontalbot]

Hi Chris! Possible logo I just made: http://share.pho.to/95k1N (background should be white). What do you think?
Update: http://pho.to/95mgw
Update2: http://pho.to/95sYK

[crisptrutski]

Hey Leon,

Great idea - cheeky but minimal. Prefer the first iteration actually - like the thinner weight. See you stretched then it vertically to avoid cropping the match tips? What do you think about rather letting the tips overlap the border, perhaps even extending out of the box.

The chief crit is that I was leaning towards something a bit more "colourful" and less sophisticate 🎃

Not sure if you saw the thread here: #1

The idea when we ended up on this name was an allusion to them 'ol toys (maybe just appropriating an image like http://ecx.images-amazon.com/images/I/511BR2C9BNL.jpg or http://www.matchboxcarspriceguide.com/images/3074.gif if it's fair use).

[crisptrutski]

Oh, think I forgot to say thanks. Thanks!

[leontalbot]

Ok. No worries. I actually like the car.
Here are other tries.
http://pho.to/964qs
http://pho.to/964rp
http://pho.to/964tI
You might just want to use your car picture as well. I like it, but I had no inspiration to do something cool with it... Maybe just the picture of the car?

[leontalbot]

Still. Here is a logo with your car picture.
http://pho.to/965B2

[leontalbot]

And finally, the first concept, adjusted as you suggested.
http://pho.to/965Ut
http://pho.to/965bA

[crisptrutski]

@leontalbot popped one of those last ones into the PR for this issue. Can check it out here: https://github.com/crisptrutski/matchbox/blob/readme-update/README.md

Note sure if a website.. or the final destination STICKERS is in Matchbox's future, so have some more feedback just from a perspective of how it sits in a github readme:

1. Not a fan of the angled outer lines on capital M - think a flat side "fits" better against the match-block. Perhaps just use Helvetica Neue so that it's consistent with the H1 headers in GH's stylesheet?
2. Now that you added a tag-line, the vertical balance feels a bit off. Maybe nudge up the text a bit?

Super stoked to have a logo! 🎉

[leontalbot]

Logo update: http://pho.to/96qWI :-)