Skip to content

Commit

Permalink
Add notes to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iva2k committed Feb 4, 2024
1 parent fb73e99 commit d23114a
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,11 @@ There are many UI frameworks that work with Svelte / SvelteKit, and choice can b

<https://sveltesociety.dev/components/>

This project has few of the top UI frameworks integrated in separate git branches:
This project has few of the top UI frameworks integrated in separate git branches.

Currently there are no plans to implement additional frameworks (either listed below or not). It is not too hard to add a new UI framework, as long as it supports Svelte 5 - just look at minimal changes in the existing framework branches.

Note that there are 2 branches for Isolated component development - Histoire and Storybook, which can be merged into UI branch of choice for your app.

<!-- prettier-ignore -->
| Git Branch | UI Framework | Dark Theme Switch | Notes |
Expand Down Expand Up @@ -242,6 +246,12 @@ This project has few of the top UI frameworks integrated in separate git branche
| | [Bits UI](https://bits-ui.com) | | |
| | [shadcn-svelte](https://www.shadcn-svelte.com) | | |

## Conclusion

This repo was started before Svelte 5 official release using the early preview releases, and few things are still broken at the time in Svelte and in some of UI framework packages. As fixes become available, they will be picked up.

Note that some of the UI frameworks were implemented flawlessly in earlier Svelte 3 / 4 version of this project, but they got behind and are incompatible with Svelte 5 (those broken branches are kept to have place where to track progress).

## Enjoy! \\\_/

![Total App](static/icon-txr-512x512.png)

0 comments on commit d23114a

Please sign in to comment.