Skip to content

Commit 3e31ed6

Browse files
committed
docs: update changelog and readme
1 parent a71f799 commit 3e31ed6

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# 2.0.0
2+
3+
**BREAKING CHANGE:** Upgraded to Svelte v5. This change is unfortunately not backwards compatible with Svelte 3 or 4. If you want to use Svelte Simple Modal with Svelte v3 or v4, check out version 1 (https://github.com/flekschas/svelte-simple-modal/tree/v1) ([#119]https://github.com/flekschas/svelte-simple-modal/pull/119)
4+
15
# 1.6.2
26

37
- Fix Svelte type resolve issue ([#107](https://github.com/flekschas/svelte-simple-modal/issues/107))

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<h1 align="center">
2-
svelte-simple-modal
2+
Svelte Simple Modal
33
</h1>
44

55
<div align="center">
@@ -26,16 +26,19 @@
2626

2727
</div>
2828

29-
**Live demo:** https://svelte.dev/repl/033e824fad0a4e34907666e7196caec4?version=3.20.1
29+
**Live demo:** https://svelte.dev/playground/b95ce66b0ef34064a34afc5c0249f313?version=5.17.3
3030

31-
**Works with:** Svelte `>=v3.30` and `v4`!
31+
**Works with:** Svelte `>=v5`!
32+
33+
> [!NOTE]
34+
> If you want to use Svelte Simple Modal with Svelte v3 or v4, check out [version 1](https://github.com/flekschas/svelte-simple-modal/tree/v1).
3235
3336
## Table of Contents
3437

3538
- [Install](#install)
3639
- [Rollup Setup](#rollup-setup)
3740
- [Usage](#usage)
38-
- [TypeScript Example](#usage-with-typescript)
41+
- [TypeScript Example](#usage-with-typescript)
3942
- [Svelte Store Example](#usage-with-a-svelte-store)
4043
- [Styling](#styling)
4144
- [SSR](#server-side-rendering)

0 commit comments

Comments
 (0)