Confusing README

[so-rose]

Is this related to a problem? Please describe.

This project is essentially perfect. The README is, however, still 100% Black's; how to use the new option requires browsing the source code, and there are for example no links to the PyPi package, notes on what works and what doesn't, etc., in the README.

This makes finding and using "tan" a confusing experience. It also makes it difficult to pitch the "tan" code style to anyone.

Describe the solution you'd like

I don't think black's... Hostility to tabs is going to change. When I pitch the "black" code style, that means pitching 4 spaces. That's their decision, but I'd suggest it means that changing it implies a uniquely named fork.

I'd much rather pitch a "tan" code style. It has a lot going for it!

• Just like black, but with "indentation freedom"! (Or something)
• 100% compatible with black. "Just use tan!".

I'd suggest:

• A paragraph describing the point of tan, linking to the issue. Some boistrous marketing perhaps :)
• Replacing 'Black' with 'Tan' where appropriate
• Replacing 'Blackened' with 'Tanned' where appropriate
• Replacing the logo
• Explicitly describing what is tan-specific, and what from black (ex. documentation) is still valid.

Describe alternatives you've considered

I understand wanting to keep mergeability with black. A unique README doesn't change that. But making tan easier to find and use does make the argument for having a tabs option stronger, and the arguments for merging it in stronger too.

I have a feeling that merge will never happen. In the meantime, why not make it easier for tab fans to find useful tools to live their life?

Context

I'd be happy to make a pull request. I just wanted to have a conversation before suggesting subjective changes :)

Fun fact: It was five years (1908 - 1913) before the original Model T could be bought in black, as opposed to red, gray, green, and red. The switch to monochromatic was ostensibly because black paint was cheapest, in the context of the WWI-era chemical industry. Even so, "black" ended up being over 30 different kinds of paint during its production. The supposed color uniformity of the Model T is a relatively inaccurate mini-legend!

[sciyoshi]

I was considering updating the README with something to that effect. Perhaps not replacing everything in the documentation, but at least adding a blurb to the top explaining why this fork exists and how to use it. I'd like to wait for @jleclanche to weigh in first however.

[jleclanche]

Feel free to update the README