Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrpmorris committed Mar 23, 2020
1 parent f2098d3 commit 4dc9924
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 11 deletions.
22 changes: 22 additions & 0 deletions Docs/upgrading-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Upgrading instructions

## Blazor.Fluxor (v1 or v2) to Fluxor (v3)
1. Uninstall the NuGet package Blazor.Fluxor and install the following:
* Fluxor
* Fluxor.Blazor.Web
* Fluxor.Blazor.Web.ReduxDevTools (if used in your app)
2. Change the following namespaces in your source code
* `Blazor.Fluxor` to `Fluxor`
* `Blazor.Fluxor.Components` to `Fluxor.Blazor.Web.Components`
* `Blazor.Fluxor.Routing` to `Fluxor.Blazor.Web.Middlewares.Routing`
* `Blazor.Fluxor.ReduxDevTools` to `Fluxor.Blazor.Web.ReduxDevTools`
3. When bootstrapping Fluxor, change the options in `services.AddFluxor` as follows
* Change `UseDependencyInjection` to `ScanAssemblies`
* Change `AddMiddleware<Blazor.Fluxor.Routing.RoutingMiddleware>();` to `UseRouting();`
* Change `AddMiddleware<Blazor.Fluxor.ReduxDevTools.ReduxDevToolsMiddleware>();` to `UseRouting();`
4. Instead of using `<Blazor.Fluxor.StoreInitializer/>` or calling `Store.Initialize()` in your razor file, add the following to your `App.razor` file
* `<Fluxor.Blazor.Web.StoreInitializer/>`
5: `FluxorComponent` now implements `IDisposable`, so override `Dispose(bool disposing)` instead of implementing `IDisposable` yourself.
6: Change the script reference from `_content/Blazor.Fluxor/index.js` to `_content/Fluxor.Blazor.Web/scripts/index.js`
7: The `Go` class in the Routing namespace is now called `GoAction`

6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ You can download the latest release / pre-release NuGet packages from the offici
* [Fluxor.Blazor.Web.ReduxDevTools](https://www.nuget.org/packages/Fluxor.Blazor.Web.ReduxDevTools) [![NuGet version (Fluxor.Blazor.Web.ReduxDevTools)](https://img.shields.io/nuget/v/Fluxor.Blazor.Web.ReduxDevTools.svg?style=flat-square)](https://www.nuget.org/packages/Fluxor.Blazor.Web.ReduxDevTools/)

## Release notes
See the [releases page](./Docs/releases.md) for release history.
See the [Releases page](./Docs/releases.md) for release history.

## Upgrading from Blazor.Fluxor (v1 or v2)
See the [Upgrading instructions](./Docs/upgrading-instructions.md) for instructions on how to upgrade from
`Blazor.Fluxor` V1 or V2 to `Fluxor`.

# Licence
[MIT](https://opensource.org/licenses/MIT)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<TargetFramework>netstandard2.1</TargetFramework>
<RazorLangVersion>3.0</RazorLangVersion>
<Version>3.0.1</Version>
<Version>3.0.2</Version>
<Authors>Peter Morris</Authors>
<Company />
<Product>ReduxDevTools for Fluxor Blazor (Web)</Product>
Expand Down
2 changes: 1 addition & 1 deletion Source/Fluxor.Blazor.Web/Fluxor.Blazor.Web.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<RazorLangVersion>3.0</RazorLangVersion>
<Authors>Peter Morris</Authors>
<Company />
<Version>3.0.1</Version>
<Version>3.0.2</Version>
<Description>A zero boilerplate Redux/Flux framework for Blazor</Description>
<Copyright>Peter Morris</Copyright>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
Expand Down
3 changes: 2 additions & 1 deletion Source/Fluxor.sln
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
.editorconfig = .editorconfig
..\README.md = ..\README.md
..\Docs\releases.md = ..\Docs\releases.md
Upgrade.txt = Upgrade.txt
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Fluxor", "Fluxor\Fluxor.csproj", "{863909D3-7E81-4240-8C0A-6F57768D28FF}"
Expand Down Expand Up @@ -85,6 +84,8 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{028DE5AF-7FF2-4E1D-8AB7-99B2668A9736}"
ProjectSection(SolutionItems) = preProject
..\Docs\README.md = ..\Docs\README.md
..\Docs\releases.md = ..\Docs\releases.md
..\Docs\upgrading-instructions.md = ..\Docs\upgrading-instructions.md
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "BasicConcepts.StateActionsReducersTutorial", "..\Tutorials\01-BasicConcepts\01A-StateActionsReducersTutorial\StateActionsReducersTutorial\BasicConcepts.StateActionsReducersTutorial.csproj", "{5E423494-7C7A-485E-8E84-A5CD11F7C504}"
Expand Down
2 changes: 1 addition & 1 deletion Source/Fluxor/Fluxor.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<TargetFramework>netstandard2.1</TargetFramework>
<Version>3.0.1</Version>
<Version>3.0.2</Version>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<Authors>Peter Morris</Authors>
<Company />
Expand Down
6 changes: 0 additions & 6 deletions Source/Upgrade.txt

This file was deleted.

0 comments on commit 4dc9924

Please sign in to comment.