Skip to content
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.

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

Update to v1 #5

Merged
merged 5 commits into from
Mar 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -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
10 changes: 0 additions & 10 deletions .github/workflows/deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
14 changes: 8 additions & 6 deletions demo/README.md
Original file line number Diff line number Diff line change
@@ -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
Loading