update readme w/ images
This commit is contained in:
parent
16973b7c85
commit
4af28bbfd7
|
@ -0,0 +1,19 @@
|
||||||
|
Copyright 2021 Geoff Doty
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
39
README.md
39
README.md
|
@ -8,39 +8,28 @@ Use at of the box or set a single custom `theme` color and watch the styles chan
|
||||||
|
|
||||||
Extend with minimal styles to create your final theme/design.
|
Extend with minimal styles to create your final theme/design.
|
||||||
|
|
||||||
All-in, this package is **only TBD!**
|
All-in, this package is **only 2kb gzipped!**
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Check it Out
|
|
||||||
|
|
||||||
- TBD
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- Tiny
|
- Tiny, 220 lines, 13 vars, 1 class, 4kb minified, 2kb gzipped
|
||||||
- Classless, include and go
|
- Classless
|
||||||
- Single `.grid` class utility helper for auto-adjusting layout solution
|
- Single `.grid` class utility helper for auto-adjusting layout solution
|
||||||
- Customizable: theme, font, border-radius, line-height, element spacing
|
- Customizable theme, font, border-radius, line-height, element spacing
|
||||||
- Extendable, its classless -- add your own classes!
|
- Extendable, its classless -- add your own classes!
|
||||||
- Pure CSS3
|
- Pure CSS3
|
||||||
|
|
||||||
> WARNING: only supports CSS3 ever-green browsers, no IE here ;)
|
> WARNING: only supports CSS3 ever-green browsers, no IE here ;)
|
||||||
|
|
||||||
|
|
||||||
|
## Check it Out
|
||||||
|
|
||||||
## Getting Started
|
**Scales CSS** builds dynamic themes based on a single color. the default theme is based on `steelblue` , and has a `dark` and `light` variant (*default dark*)
|
||||||
|
|
||||||
Latest minified build is available in the `dist`/ folder. or you can
|
|
||||||
|
|
||||||
- TBD
|
|
||||||
|
|
||||||
To see what it looks like, see
|
|
||||||
|
|
||||||
- TBD
|
|
||||||
|
|
||||||
|
<div style="display: flex">
|
||||||
|
<img src="example/img/steelblue-dark.png" width="400">
|
||||||
|
<img src="example/img/steelblue-light.png" width="400">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
## Develop
|
## Develop
|
||||||
|
@ -49,7 +38,13 @@ clone repository and... TBD
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## TODOs
|
## LICENSE
|
||||||
|
|
||||||
|
- [MIT](LICENSE)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## TODO
|
||||||
|
|
||||||
- Get Download to work with custom dist download
|
- Get Download to work with custom dist download
|
||||||
|
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 310 KiB |
Binary file not shown.
After Width: | Height: | Size: 314 KiB |
Loading…
Reference in New Issue