css-variable icon indicating copy to clipboard operation
css-variable copied to clipboard

Please add better docs and examples

Open Farnsi opened this issue 2 years ago • 1 comments

As a css-in-js newbie, i have really no idea how to use this lib when i read only the website.

After study the code and the examples it got clearer. But big waste of time, if everybody has to do that.

You should add a sentence for which benefit this lib is absolute needed and superior to other solutions. E.g. why should i use this and not the things inlcuded in styled-components like theming? smaller virtual DOM updates for a newbie like me, how, what perfomance gain could i expect?

Example from Webpage: What are tokens? Why i need and define tokens? Confusing example "Create themeable CSS Snipptes": What is gradientStartColor variable? is it mistyped startColor?

Describe the api: Which parameters has createVar? How to access them? with .val, with .toStyle(...)? createGlobalTheme with scope without scope "", difference?

Farnsi avatar Mar 18 '23 09:03 Farnsi

As a veteran css-in-js user, I must agree and am missing first and foremost one crucial detail: what problem does this package solve? Thanks!

elektronik2k5 avatar Mar 30 '23 18:03 elektronik2k5