Skip to content

Commit 1e504ae

Browse files
authored
docs: add project intent
1 parent 7b77a6d commit 1e504ae

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,29 @@ See our landing page: [**https://timeless.platformoon.com**](https://timeless.pl
88

99
This application monitors WhatsApp messages for signs of purchases (such as receipts, audio messages, transfers), extracts relevant information (amounts, descriptions), and automatically sends it to **Timeless**, helping you keep your finances organized — effortlessly.
1010

11+
## Project Intent
12+
13+
Great choice. Option 1 strikes a perfect balance between professional transparency and the "builder" mindset.
14+
15+
Here is how your updated README would look with the disclaimer integrated. I've placed it right after the Overview to establish the project's purpose early on.
16+
17+
🕰️ Timeless
18+
Do you often make purchases and forget to write them down? Timeless is a project designed to help you by automatically detecting purchase-related messages on WhatsApp and registering that data in the Timeless app — your personal financial organization hub.
19+
20+
See our landing page: https://timeless.platformoon.com
21+
22+
✨ Overview
23+
This application monitors WhatsApp messages for signs of purchases (such as receipts, audio messages, transfers), extracts relevant information (amounts, descriptions), and automatically sends it to Timeless, helping you keep your finances organized — effortlessly.
24+
25+
⚠️ Project Intent
26+
Timeless is primarily an educational project built to explore the intersection of automated messaging, NLP, and cloud infrastructure. While it mimics real-world financial tracking systems, its core goal is to demonstrate:
27+
28+
**Production-like Architecture**: Integrating Java/Quarkus with AI and external messaging APIs.
29+
30+
**Continuous Improvement**: The codebase is designed to evolve. We encourage experiments with local LLMs and different cloud providers.
31+
32+
**Learning by Doing**: This is a sandbox for implementing "real-world" logic in a controlled environment. Feel free to refactor, break, and improve!
33+
1134
## 🚀 Features
1235

1336
- 📩 Automatic reading of WhatsApp messages
@@ -98,4 +121,4 @@ You should receive something like it:
98121

99122
### How to contribute
100123

101-
[CONTRIBUTING.md](CONTRIBUTING.md)
124+
[CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)