Skip to content

Commit 85e3bcc

Browse files
Fix: updated absolute and relative URLs
1 parent 6e3b6ad commit 85e3bcc

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
This is a **complete ground-up rewrite** (version 3.0.0+) of the original `curo` package, now aligned with the latest Dart conventions and fully compatible in design and accuracy with its sister project, [`curo-python`](https://github.com/andrewmurphy353/curo_python).
1111

12-
Explore the [documentation](https://pub.dev/documentation/curo/latest/), try it live in the **[Curo Calculator](https://curocalc.app)** app (built with this library), or browse the [examples](https://github.com/andrewmurphy353/curo/examples/overview).
12+
Explore the [documentation](https://pub.dev/documentation/curo/latest/), try it live in the **[Curo Calculator](https://curocalc.app)** app (built with this library), or browse the [examples](https://andrewmurphy353.github.io/curo/examples/overview).
1313

1414
## Why Curo?
1515

@@ -115,7 +115,7 @@ Most conventions default to period-by-period timing. For XIRR-style calculations
115115

116116
Cash flow diagrams visually represent the timing and direction of financial transactions. For example, a €10,000 loan repaid in 6 monthly instalments would look like this:
117117

118-
![Cash Flow Diagram](https://github.com/andrewmurphy353/curo/blob/main/doc/site/assets/images/example-01.png)
118+
![Cash Flow Diagram](https://andrewmurphy353.github.io/curo/assets/images/example-01.png)
119119

120120
- **Down arrows**: Money received (e.g., loan advance).
121121
- **Up arrows**: Money paid (e.g., instalments).
@@ -129,6 +129,6 @@ Released under the [MIT License](LICENSE).
129129
## Learn More
130130

131131
- **Examples**: Dive into practical use cases in the documentation [examples](https://andrewmurphy353.github.io/curo/examples/overview/).
132-
- **Documentation**: Refer to the code [documentation](https://andrewmurphy353.github.io/curo/api/) for detailed class and method descriptions.
132+
- **Documentation**: Refer to the code [documentation](https://andrewmurphy353.github.io/curo/api) for detailed class and method descriptions.
133133
- **Issues & Contributions**: Report bugs or contribute on [GitHub](https://github.com/andrewmurphy353/curo/issues).
134134

doc/site/examples/example_01.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Example 1: Determine a payment in an arrears repayment profile
22

3-
This example illustrates the use of one of two [Modes](https://andrewmurphy353.github.io/curo/api/calculator/Mode.html), a core concept in financial calculations, when solving for unknowns.
3+
This example illustrates the use of one of two [Modes](/api/curo/Mode.html), a core concept in financial calculations, when solving for unknowns.
44

55
## Overview
66

77
This example demonstrates how to calculate the value of a payment when it's due at the end of each repayment period, known as 'in arrears'. To switch to payments due at the beginning of each period ('in advance'), simply set `mode: Mode.advance` in the `SeriesPayment`.
88

99
## Code
1010

11-
This example solves for an unknown instalment amount for a $10,000 loan over six months, the default [Frequency](https://andrewmurphy353.github.io/curo/api/calculator/Frequency.html) if not defined.
11+
This example solves for an unknown instalment amount for a $10,000 loan over six months, the default [Frequency](/api/curo/Frequency.html) if not defined.
1212

1313
After the unknown values are solved we confirm the implicit interest rate (IRR) in the resulting profile equals the provided interest rate.
1414

doc/site/examples/example_02.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ This example illustrates the use of the one of three supported legally defined A
44

55
## Overview
66

7-
This example demonstrates how to calculate the Annual Percentage Rate (APR) for a consumer loan, in accordance with the [EU 2008/48 APR](https://andrewmurphy353.github.io/curo/api/calculator/EU200848EC-class.html). The same approach works for any supported APR convention (e.g., [US Appendix J APR](https://andrewmurphy353.github.io/curo/api/calculator/USAppendixJ-class.html) or [UK Conc App APR](https://andrewmurphy353.github.io/curo/api/calculator/UKConcApp-class.html)).
7+
This example demonstrates how to calculate the Annual Percentage Rate (APR) for a consumer loan, in accordance with the [EU 2008/48 APR](/api/curo/EU200848EC-class.html). The same approach works for any supported APR convention (e.g., [US Appendix J APR](/api/curo/USAppendixJ-class.html) or [UK Conc App APR](/api/curo/UKConcApp-class.html)).
88

99
## Code
1010

1111
This example solves for an unknown APR for a €10,000 loan over six months, including a €50 fee due with the first instalment.
1212

13-
First the unknown instalment payment is solved using `US30U360`, a [standard convention](https://andrewmurphy353.github.io/curo/api/calculator/US30U360-class.html), and then we show how to confirm the APR thereafter. If all values are known beforehand, skip the `solveValue` step and go straight to solving the implicit APR.
13+
First the unknown instalment payment is solved using `US30U360`, a [standard convention](/api/curo/US30U360-class.html), and then we show how to confirm the APR thereafter. If all values are known beforehand, skip the `solveValue` step and go straight to solving the implicit APR.
1414

1515
Notes:
1616

doc/site/examples/example_03.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Important: Ensure the payment and interest capitalisation schedules end on the s
1010

1111
## Code
1212

13-
This example solves for an unknown instalment amount for a $10,000 loan over six months, the default [Frequency](https://andrewmurphy353.github.io/curo/api/calculator/Frequency.html) if not defined, with quarterly compound interest.
13+
This example solves for an unknown instalment amount for a $10,000 loan over six months, the default [Frequency](/api/curo/Frequency.html) if not defined, with quarterly compound interest.
1414

1515
We demonstrate that this type of calculation requires at least two `SeriesPayment` series:
1616

0 commit comments

Comments
 (0)