aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillermo Ramos2025-04-04 19:31:23 +0200
committerGuillermo Ramos2025-04-04 20:15:31 +0200
commit6eb81734951cb6e14727038087e9c106589b5dc8 (patch)
treeb0368225f7b1a5e0d7d4965eda3e7a1a10400699
parentac10e7fed68ef0ed6c2f2e73f698afaa8763d80e (diff)
downloadhiccup-master.tar.gz
Add READMEHEADmaster
-rw-r--r--README.md21
-rw-r--r--sample.pngbin0 -> 159544 bytes
2 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..15429f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Hiccup
+
+Mortgage simulator, overcharged. Because things are not so simple. Rates change over time, maybe you
+plan on reducing monthly quotas via early payments, and you want to know how much you will be saving
+on interest by doing it (or the difference between paying now or in 2 years).
+
+A tool to help making decisions backed by actual data, written by its first user. Hope you like it ❤
+
+Try it live: [https://hiccup.gramos.me](https://hiccup.gramos.me)
+
+![sample](sample.png)
+
+## Nerd stuff
+
+Backend in Rust, frontend in Elm.
+
+Requirements: cargo, npm.
+
+Setup: `make web`
+
+(There's also a CLI mode which was developed before the webapp, you can test it with `make cli`)
diff --git a/sample.png b/sample.png
new file mode 100644
index 0000000..1f49d25
--- /dev/null
+++ b/sample.png
Binary files differ