summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2023-08-25 20:30:25 +0530
committerGitHub <noreply@github.com>2023-08-25 20:30:25 +0530
commitd34c3513a666e6c6d9955dba5e57c36916a0b274 (patch)
treec8aad4a6454c7fd8737ba14a7f8314d253818db5 /README.md
parentc2b13c69a9b8f52eaeb6773690ab3247f98a3487 (diff)
downloadcss-everything-d34c3513a666e6c6d9955dba5e57c36916a0b274.tar.gz
css-everything-d34c3513a666e6c6d9955dba5e57c36916a0b274.zip
Update README.md
Diffstat (limited to '')
-rw-r--r--README.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/README.md b/README.md
index f8998bc..58c3ed9 100644
--- a/README.md
+++ b/README.md
@@ -9,15 +9,14 @@ A ui library where you only write CSS. No HTML, no JS, no build system, only CSS
> Disclaimer: Don't use this
-## Usage
+## Docs
- [Read the documentation](https://github.com/phenax/css-everything/tree/main/docs/README.md) to become enlightened.
- [Here's how this works](https://github.com/phenax/css-everything/tree/main/docs/how-it-works.md).
-### Simple example
-You can start by adding the script tag for the renderer in your document
-
+## Examples
+All the magic starts with adding the renderer script tag to your html and having a `--cssx-children` property set on your `body` -
```html
<script async defer src="https://unpkg.com/@css-everything/render/dist/renderer/index.js"></script>
```