Skip to content

docs: improve README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


![Snowfall Demo](./assets/snowfall-demo.gif)

# Solid Snowfall
Expand Down Expand Up @@ -36,13 +38,14 @@ pnpm add solid-snowfall
Basic usage requires no properties - it will grow to fill the nearest relative positioned parent element.

```tsx
import { render } from "solidjs/web";
import SnowFall from "solid-snowfall";
import { render } from "solid-js/web";
import Snowfall from "solid-snowfall";

render(
() => (
<>
<SnowFall />
<Snowfall />
</>
),
document.getElementById("root") as HTMLDivElement,
);
Expand Down Expand Up @@ -124,4 +127,4 @@ If you want the component to cover the entire screen then you can change the pos
left: 0
}}
/>
```
```