From 6eb81734951cb6e14727038087e9c106589b5dc8 Mon Sep 17 00:00:00 2001
From: Guillermo Ramos
Date: Fri, 4 Apr 2025 19:31:23 +0200
Subject: Add README

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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`)
-- 
cgit v1.2.3