Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
devope committed Dec 29, 2023
1 parent 834be1a commit c17bb73
Showing 1 changed file with 66 additions and 17 deletions.
83 changes: 66 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,71 @@
# Classless framework
# `🫙` clsls

- zero classes
- zero dependencies
- combine html tags to achive results
> classless framework for fast prototyping
[Demo](https://clsls.github.io/framework/)
- `0` classes
- `0` dependencies
- use plain HTML tags to get pleasant look
- combine tags to get more complex components
- customize colors and decorations easily
- auto enabling dark `||` light theme based on system preferences

## Theming variables
## Demos

If you want to create your own theme just reassign values for these variables:
- [Main](https://clsls.github.io/framework/) with docs by innspecting source code `🗿`

- `--clsls-color-background`
- `--clsls-color-text`
- `--clsls-color-link-hover`
- `--clsls-color-button`
- `--clsls-color-main`
- `--clsls-color-opposite`
- `--clsls-line-thickness`
- `--clsls-radius`
- `--clsls-font-main`
- `--clsls-zoom-main`
## Install

For last version:

```html
<link href="https://clsls.github.io/framework/src/index.css" rel="stylesheet" />
```

## Customize

To create your own theme just rewrite following variables in your CSS file:

```css
{
/* colors */
--clsls-color-main: ;
--clsls-color-opposite: ;
--clsls-color-background: ;
--clsls-color-text: ;
--clsls-color-link-hover: ;
--clsls-color-button: ;
--clsls-color-border: ;
--clsls-color-code: ;
/* fonts */
--clsls-font-heading: ;
--clsls-font-text: ;
/* other */
--clsls-line-thickness: ;
--clsls-radius: ;
--clsls-zoom-main: ;
--clsls-icon-chevron: ;
}
```

## Roadmaps

### v2

- [x] code block
- [x] seprate font for headline
- [ ] card component
- [ ] dotted link
- [ ] sizes for buttons
- [ ] more demos
- [ ] checkboxes
- [ ] npm install support
- [ ] better docs page with code to copy

### v3

- [ ] match variable name with CSS properties and HTML tags
- [ ] `--clsls-color-link-hover`
- [ ] `--clsls-radius``--clsls-border-radius`
- [ ] `--clsls-line-thickness``--clsls-border-width`
- [ ] `--clsls-color-code``--clsls-color-code-background`
- [ ] deletion of `--clsls-zoom-main`?

0 comments on commit c17bb73

Please sign in to comment.