Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KennyOliver authored Apr 1, 2021
1 parent b031730 commit 26559b2
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,39 @@ Use "group" as a container for encapsulating groups of neumorphia.css elements.
```html
<div class="neu ..."></div>
```
##### Helper classes for styling (mandatory)
:warning: your elements will not be displayed without one of these!

flat, convex, concave, inset, outset,

Put one of the 5 styles in the gap
```html
<div class="neu ____"></div>
```

Note: underscores represent a style helper class


#### "hr-bar"
* "hr-bar" is the only exception of elements; but it's very simple to use
* Use ```html <hr "hr-bar"> ```
* "neu" is not needed
* Place it wherever: between "chunk"s, "group"s, elements, etc.

```html
<hr class="hr-bar">
```

#### "squircle" & "circle"
* Basic buttons
* Expect **1** character (or FontAwesome icon) as the content

_Don't forget the styles!_
```html
<div class="neu ____ squircle">CONTENT</div>
<div class="neu ____ circle">CONTENT</div>
```

####

---
Kenny Oliver ©2021

0 comments on commit 26559b2

Please sign in to comment.