release 1

.github/workflows/docs.yml

@@ -16,7 +16,7 @@ jobs:
         run: dotnet tool restore
       - name: Build code
         run: dotnet build -c Release
-      - name: Generate the documentation'
+      - name: Generate the documentation
         run: dotnet fsdocs build --properties Configuration=Release --eval
       - name: Upload documentation
         uses: actions/upload-pages-artifact@v3

README.md

@@ -12,14 +12,14 @@ Initial features:
 > amortisation
 
 This library operates partially in area where business is regulated by various regulators.
-Though every care has been taken to ensure the accuracy of the results, care should be taken to validate figures produced by it.
+Though every care has been taken to ensure the accuracy of the results, please independently validate figures produced by it.
 It is not audited or validated by any of the regulators.
 
+If you have any suggestions or corrections, please feel free to comment or create a pull request.
+
 For commercial use the user might need an operating license and to fulfil various statutory and regulatory requirements,
 none of which are conferred by the use of this library.
 
-Note: this is a work in progress so breaking changes can happen at any time while in version 0.
-
 NuGet package: https://www.nuget.org/packages/FSharp.Finance.Personal/
 
 Documentation: https://simontreanor.github.io/FSharp.Finance.Personal/

src/FSharp.Finance.Personal.fsproj

@@ -33,7 +33,7 @@
   <PropertyGroup Condition="'$(Configuration)'=='Release'">
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageId>FSharp.Finance.Personal</PackageId>
-    <Version>0.15.0</Version>
+    <Version>1.0.0</Version>
     <Authors>Simon Treanor</Authors>
     <PackageDescription>F# Personal Finance Library</PackageDescription>
     <RepositoryUrl>https://github.com/simontreanor/FSharp.Finance.Personal</RepositoryUrl>

src/Rescheduling.fs

@@ -144,7 +144,7 @@ module Rescheduling =
                     Interest = rp.Interest |> ValueOption.defaultValue sp.Interest
                     Calculation = rp.Calculation |> ValueOption.defaultValue sp.Calculation
                 }
-            // create the new amortiation schedule
+            // create the new amortisation schedule
             let! rescheduledSchedule = Amortisation.generate spNew IntendedPurpose.Statement ScheduleType.Original true [||] // sic: `ScheduledPaymentType.Original` is correct here as this is a new schedule
             return quote.RevisedSchedule, rescheduledSchedule
         }