Skip to content

update readme , prepare publish nuget #19

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
goswinr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update readme , prepare publish nuget #19

Show file tree
Hide file tree
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
27 changes: 24 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,30 @@
# Fable.Solid

Fable bindings for [SolidJS](https://www.solidjs.com/). You can use it in combination with Feliz.JSX.Solid to write React-like apps without a Virtual DOM. Read [this post](https://fable.io/blog/2022/2022-10-18-fable-solid.html) for more information.

To test run `npm install && npm start`.
This repository contains:

### Fable.Solid
![NuGet Version](https://img.shields.io/nuget/v/Fable.Solid)

Fable bindings for [SolidJS](https://www.solidjs.com/).
You can use it in combination with [Feliz.JSX.Solid](https://github.com/fable-compiler/Feliz.JSX) to write React-like apps without a Virtual DOM.
Read [this post](https://fable.io/blog/2022/2022-10-18-fable-solid.html) for more information.

(in folder [src/Fable.Solid](src/Fable.Solid))

### Elmish.Solid
![NuGet Version](https://img.shields.io/nuget/v/Elmish.Solid)

Elmish bindings for SolidJS.
To use the [Elmish](https://elmish.github.io/elmish/) architecture with SolidJS
(in folder [src/Elmish.Solid](src/Elmish.Solid))

### A sample app
You can see it live [here](https://fable-compiler.github.io/Fable.Solid/)
To compile and watch via Vite run `npm install && npm start`.
In folder [src/App](src/App)

> Note: Requires Fable 4

![Screen cast](./screencast.gif)

> Note: Requires Fable 4
2 changes: 1 addition & 1 deletion src/Elmish.Solid/Elmish.Solid.fsproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<Version>1.0.0</Version>
<PackageVersion>1.0.0-beta-002</PackageVersion>
<PackageVersion>1.0.0-beta-003</PackageVersion>
<TargetFramework>netstandard2.0</TargetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
Expand Down
4 changes: 4 additions & 0 deletions src/Elmish.Solid/RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### 1.0.0-beta-003

- Update to Solid 1.8

### 1.0.0-beta-002

- Terminate Elmish program on cleanup
Expand Down
2 changes: 1 addition & 1 deletion src/Fable.Solid/Fable.Solid.fsproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<Version>1.0.0</Version>
<PackageVersion>1.0.0-beta-004</PackageVersion>
<PackageVersion>1.0.0-beta-005</PackageVersion>
<TargetFramework>netstandard2.0</TargetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
Expand Down
5 changes: 5 additions & 0 deletions src/Fable.Solid/RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
### 1.0.0-beta-005

* Update to Solid 1.8
* Fix Show binding

### 1.0.0-beta-004

* Add ErrorBoundary
Expand Down