Clean Up ReadMe Documentation

intuit / postcss-themed

A PostCSS plugin for generating themes.

MIT License

62 stars 32 forks source link

Open tylerkrupicka opened 3 years ago

tylerkrupicka commented 3 years ago

Right now the documentation in the ReadMe is a little hard to follow and could use some improvements. I think it would be helpful to:

Break apart the modern and legacy generation into separate sections which explain the differences in how they work and how you use them.
Create a legend at the top of the readme that links to individual configuration options or examples.
Clean up headers and documentation text.

anjaliguptaz commented 2 years ago

@tylerkrupicka Is this still valid and needs to be done ?

anchal0997 commented 2 years ago

Hi @tylerkrupicka, I would like to contribute to this issue.