Merge pull request #5 from CompositionalIT/update-to-v1

Update to v1

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Build
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out
+      uses: actions/checkout@v4
+
+    - name: Restore tools
+      run: dotnet tool restore
+
+    - name: Build
+      run: dotnet build --configuration Release
+
+    - name: Restore demo tools
+      run: dotnet tool restore
+      working-directory: ./demo
+
+    - name: Build Demo
+      run: npm run build
+      working-directory: ./demo

.github/workflows/deployment.yml

@@ -14,11 +14,6 @@ jobs:
     - name: Check out
       uses: actions/checkout@v4
 
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v4
-      with:
-        dotnet-version: 8.0.x
-
     - name: Restore tools
       run: dotnet tool restore
 
@@ -34,11 +29,6 @@ jobs:
       run: dotnet nuget push "*.nupkg" --api-key ${{secrets.NUGET_API_KEY}} --source https://api.nuget.org/v3/index.json
       working-directory: ./src/Feliz.ReactSpeedometer
 
-    - name: Setup node
-      uses: actions/setup-node@v4
-      with:
-        node-version: 20
-
     - name: Restore demo tools
       run: dotnet tool restore
       working-directory: ./demo

README.md

@@ -2,13 +2,22 @@
 
 Feliz style bindings for [react-d3-speedometer](https://www.npmjs.com/package/react-d3-speedometer)
 
+## Version Compatibility
+
+### The table below gives the ranges of compatible versions of Feliz ReactSpeedometer with its dependent packages.
+
+| Feliz.ReactSpeedometer | react-d3-speedometer | React | Fable | Feliz |
+|------------------------|----------------------|-      |-      |-      |
+| 0.0.4                  | 2.x                  | 17.x  | 3.x   | 1.x   |
+| 1.x                    | 1.x                  | 18.x  | 4.x   | 2.x   |
+
 ## Installation
 
 ```f#
 cd ./project
 femto install Feliz.ReactSpeedometer
 ```
 
-## Demo 
+## Demo
 
 A live example can be found [here](https://compositionalit.github.io/Feliz-ReactSpeedometer/)

demo/README.md

@@ -1,15 +1,17 @@
 # Setup
 
+Run the following commands
+
+`dotnet tool restore`
+
+`npm run start`
+
 ## Components.fs
-All styling has been done, you should just need to use the `StyledComponents` module 
+All styling has been done, you should just need to use the `StyledComponents` module
 
 - Navbar
 - Description (update name and npm/nuget links)
 - Demo (react-wrapper)
 - Props (any props you'd like to demo)
 - Installation (`cd ./project` + `femto install XXX`)
-- Sample code
-
-## Deploying
-- In the `publish.js` update the repo link to the relevant wrapper
-- `npm run publish-docs` will deploy the docs
+- Sample code