docs: add initial README

.github/img/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="464" zoomAndPan="magnify" viewBox="0 0 348 98.999996" height="132" preserveAspectRatio="xMidYMid meet" version="1.0"><defs><g/><clipPath id="4c1c77f4e0"><path d="M 0 0 L 98.25 0 L 98.25 98.25 L 0 98.25 Z M 0 0 " clip-rule="nonzero"/></clipPath></defs><g clip-path="url(#4c1c77f4e0)"><path fill="#fbb700" d="M 63.074219 79.550781 L 20.476562 36.953125 L 30.851562 26.582031 L 63.074219 58.808594 L 93.726562 28.15625 C 85.832031 11.507812 68.871094 -0.00390625 49.222656 -0.00390625 C 29.558594 -0.00390625 12.59375 11.523438 4.703125 28.191406 L 45.78125 69.265625 L 35.5 79.550781 L 0.238281 44.289062 C 0.078125 45.914062 -0.0078125 47.558594 -0.0078125 49.222656 C -0.0078125 76.410156 22.035156 98.453125 49.222656 98.453125 C 76.410156 98.453125 98.453125 76.410156 98.453125 49.222656 C 98.453125 47.597656 98.371094 45.992188 98.21875 44.40625 L 63.074219 79.550781 " fill-opacity="1" fill-rule="nonzero"/></g><g fill="#fbb700" fill-opacity="1"><g transform="translate(104.174024, 62.306856)"><g><path d="M 44.65625 -27.40625 L 35.703125 0 L 28.890625 0 L 22.859375 -18.546875 L 16.640625 0 L 9.859375 0 L 0.859375 -27.40625 L 7.4375 -27.40625 L 13.625 -8.140625 L 20.078125 -27.40625 L 25.953125 -27.40625 L 32.21875 -7.984375 L 38.59375 -27.40625 Z M 44.65625 -27.40625 "/></g></g></g><g fill="#fbb700" fill-opacity="1"><g transform="translate(151.376399, 62.306856)"><g><path d="M 16.40625 -9.703125 L 16.40625 0 L 10.0625 0 L 10.0625 -9.78125 L -0.546875 -27.40625 L 6.1875 -27.40625 L 13.5 -15.21875 L 20.828125 -27.40625 L 27.046875 -27.40625 Z M 16.40625 -9.703125 "/></g></g></g><g fill="#fbb700" fill-opacity="1"><g transform="translate(179.517888, 62.306856)"><g><path d="M 21.765625 -14.125 L 27.5625 -14.125 L 27.5625 -3.015625 C 26.070312 -1.890625 24.347656 -1.023438 22.390625 -0.421875 C 20.429688 0.171875 18.460938 0.46875 16.484375 0.46875 C 13.640625 0.46875 11.082031 -0.132812 8.8125 -1.34375 C 6.539062 -2.5625 4.757812 -4.242188 3.46875 -6.390625 C 2.175781 -8.546875 1.53125 -10.984375 1.53125 -13.703125 C 1.53125 -16.410156 2.175781 -18.84375 3.46875 -21 C 4.757812 -23.15625 6.550781 -24.835938 8.84375 -26.046875 C 11.144531 -27.265625 13.726562 -27.875 16.59375 -27.875 C 19 -27.875 21.175781 -27.46875 23.125 -26.65625 C 25.082031 -25.84375 26.726562 -24.664062 28.0625 -23.125 L 24 -19.375 C 22.039062 -21.4375 19.675781 -22.46875 16.90625 -22.46875 C 15.15625 -22.46875 13.601562 -22.101562 12.25 -21.375 C 10.894531 -20.644531 9.835938 -19.613281 9.078125 -18.28125 C 8.328125 -16.945312 7.953125 -15.421875 7.953125 -13.703125 C 7.953125 -12.003906 8.328125 -10.488281 9.078125 -9.15625 C 9.835938 -7.820312 10.890625 -6.785156 12.234375 -6.046875 C 13.578125 -5.304688 15.109375 -4.9375 16.828125 -4.9375 C 18.660156 -4.9375 20.304688 -5.328125 21.765625 -6.109375 Z M 21.765625 -14.125 "/></g></g></g><g fill="#fbb700" fill-opacity="1"><g transform="translate(211.377616, 62.306856)"><g><path d="M 3.25 -27.40625 L 9.59375 -27.40625 L 9.59375 0 L 3.25 0 Z M 3.25 -27.40625 "/></g></g></g><g fill="#fbb700" fill-opacity="1"><g transform="translate(225.898603, 62.306856)"><g><path d="M 44.65625 -27.40625 L 35.703125 0 L 28.890625 0 L 22.859375 -18.546875 L 16.640625 0 L 9.859375 0 L 0.859375 -27.40625 L 7.4375 -27.40625 L 13.625 -8.140625 L 20.078125 -27.40625 L 25.953125 -27.40625 L 32.21875 -7.984375 L 38.59375 -27.40625 Z M 44.65625 -27.40625 "/></g></g></g><g fill="#fbb700" fill-opacity="1"><g transform="translate(273.100981, 62.306856)"><g><path d="M 16.40625 -9.703125 L 16.40625 0 L 10.0625 0 L 10.0625 -9.78125 L -0.546875 -27.40625 L 6.1875 -27.40625 L 13.5 -15.21875 L 20.828125 -27.40625 L 27.046875 -27.40625 Z M 16.40625 -9.703125 "/></g></g></g><g fill="#fbb700" fill-opacity="1"><g transform="translate(301.242474, 62.306856)"><g><path d="M 28.375 -27.40625 L 28.375 0 L 22.03125 0 L 22.03125 -11.234375 L 9.59375 -11.234375 L 9.59375 0 L 3.25 0 L 3.25 -27.40625 L 9.59375 -27.40625 L 9.59375 -16.59375 L 22.03125 -16.59375 L 22.03125 -27.40625 Z M 28.375 -27.40625 "/></g></g></g></svg>

README.md

@@ -1 +1,81 @@
-# radar_da_inovacao_web
+<h1 align="center">
+  <br>
+  ![WYGIWYH](.github/img/logo.svg)
+  <br>
+  WYGIWYH
+  <br>
+</h1>
+
+<h4 align="center">A powerful non-budget finance tracker.</h4>
+
+<p align="center">
+  <a href="#why-wygiwyh">Why</a> •
+  <a href="#key-featuers">Features</a> •
+  <a href="#how-to-use">Usage</a> •
+  <a href="#how-it-works">How</a> •
+</p>
+
+![screenshot](https://raw.githubusercontent.com/amitmerchant1990/electron-markdownify/master/app/img/markdownify.gif)
+
+**WYGIWYH** (_What You Get Is What You Have_) is a powerful, principles-first finance tracker designed for people who prefer a no-budget, straightforward approach to managing their money. With features like multi-currency support, customizable transactions, and a built-in dollar-cost averaging tracker, WYGIWYH helps you take control of your finances with simplicity and flexibility.
+
+## Why WYGIWYH?
+Managing money can feel unnecessarily complex, but it doesn’t have to be. WYGIWYH (pronounced "wiggy-wih") is based on a simple principle:
+
+> Use what you earn this month for this month. Any savings are tracked but treated as untouchable for future months.
+
+By sticking to this straightforward approach, you avoid dipping into your savings while still keeping tabs on where your money goes.
+
+While this philosophy is simple, finding tools to make it work wasn’t. I initially used a spreadsheet, which served me well for years—until it became unwieldy as I started managing multiple currencies, accounts, and investments. I tried various financial management apps, but none met my key requirements:
+
+1. **Multi-currency support** to track income and expenses in different currencies.
+2. **Not a budgeting app** — as I dislike budgeting constraints.
+3. **Web app usability** (ideally with mobile support, though optional).
+4. **Automation-ready API** to integrate with other tools and services.
+5. **Custom transaction rules** for credit card billing cycles or similar quirks.
+
+Frustrated by the lack of comprehensive options, I set out to build **WYGIWYH** — an opinionated yet powerful tool that I believe will resonate with like-minded users.
+
+## Key Features
+
+**WYGIWYH** offers an array of features designed to simplify and streamline your personal finance tracking:
+
+* **Unified transaction tracking**: Record all your income and expenses, organized in one place.
+* **Multiple accounts support**: Keep track of where your money and assets are stored (banks, wallets, investments, etc.).
+* **Out-of-the-box multi-currency support**: Dynamically manage transactions and balances in different currencies.
+* **Custom currencies**: Create your own currencies for crypto, rewards points, or any other models.
+* **Automated adjustments with rules**: Automatically modify transactions using customizable rules.
+* **Built-in Dollar-Cost Average (DCA) tracker**: Essential for tracking recurring investments, especially for crypto and stocks.
+* **API support for automation**: Seamlessly integrate with existing services to synchronize transactions.
+
+## How To Use
+
+To run this application, you'll need [Git](https://git-scm.com) and [Docker](https://docs.docker.com/engine/install/) with the [docker-compose](https://docs.docker.com/compose/install/).
+
+From your command line:
+
+> [!NOTE]
+> Docker images for this project are currently under development, but manual setup is available now.
+
+```bash
+# Clone this repository
+$ git clone https://github.com/eitchtee/WYGIWYH
+
+# Go into the repository
+$ cd WYGIWYH
+
+# Fill the .env file with your configurations
+$ cp .env.example .env
+$ nano .env # or any other editor you want to use
+
+# Create docker-compose file
+$ cp docker-compose.prod.yml docker-compose.yml
+
+# Run the app
+$ docker compose up -d --build
+
+# Create the first admin account
+$ docker compose exec -it web python manage.py createsuperuser
+```
+
+## How it works