Skip to content

Commit aa380f7

Browse files
feat: Add support and sponsorship information to documentation (#255)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent b2ac23d commit aa380f7

File tree

6 files changed

+148
-35
lines changed

6 files changed

+148
-35
lines changed

β€Ž.github/FUNDING.ymlβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github:
2+
- "ctasada"

β€ŽREADME.mdβ€Ž

Lines changed: 83 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66

77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
88
[![Python 3.13+](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/)
9-
[![Django 5.2+](https://img.shields.io/badge/django-5.2+-green.svg)](https://www.djangoproject.com/)
9+
[![Django 6.0+](https://img.shields.io/badge/django-6.0+-green.svg)](https://www.djangoproject.com/)
10+
[![GitHub Sponsors](https://img.shields.io/github/sponsors/ctasada?label=Sponsor&logo=github&color=ea4aaa)](https://github.com/sponsors/ctasada)
1011

11-
[Quickstart](docs/Quickstart.md) β€’ [Documentation](docs/Home.md) β€’ [Contributing](CONTRIBUTING.md)
12+
[Quickstart](docs/Quickstart.md) β€’ [Documentation](docs/Home.md) β€’ [Contributing](CONTRIBUTING.md) β€’ [Sponsor](https://github.com/sponsors/ctasada)
1213

1314
---
1415

@@ -169,3 +170,83 @@ Special thanks to all [contributors](https://github.com/ctasada/stonks-overwatch
169170
**⭐ If you find Stonks Overwatch useful, please star the project! ⭐**
170171

171172
Made with ❀️ by the Stonks Overwatch community
173+
174+
---
175+
176+
## ❀️ Why Sponsor Me?
177+
178+
Hi, I'm Carlosβ€”the creator and maintainer of Stonks Overwatch. Let me share why I built this project and why your support matters.
179+
180+
### The Story Behind Stonks Overwatch
181+
182+
Like many investors, I found myself juggling multiple broker accountsβ€”DEGIRO for stocks, Bitvavo for crypto, IBKR for international markets. Each broker had its own interface, its own way of presenting data, and none of them gave me the unified view I needed to truly understand my portfolio.
183+
184+
The commercial alternatives? They either charged monthly fees I couldn't justify, collected and sold my financial data, or required me to trust third-party cloud services with my most sensitive information. That didn't sit right with me.
185+
186+
So I built Stonks Overwatchβ€”a privacy-first, open-source solution that runs entirely on your machine. Your data never leaves your computer. No subscriptions. No data selling. Just honest, transparent portfolio tracking.
187+
188+
### The Reality of Maintaining This Project
189+
190+
**Time Investment:** I spend a lot of my free time over the last year to build an improve Stonks Overwatch:
191+
- Fixing bugs and responding to issues
192+
- Improving the UI/UX based on feedback
193+
- Writing documentation and guides
194+
- Building native desktop applications for all platforms
195+
196+
**What I've Built So Far:**
197+
- βœ… Full integration with DEGIRO (real-time data)
198+
- βœ… Beta support for Bitvavo and IBKR
199+
- βœ… Native desktop apps for Windows, macOS, and Linux
200+
- βœ… Comprehensive portfolio analytics and visualization
201+
- βœ… Dividend tracking and forecasting
202+
- βœ… Fee analysis across all brokers
203+
- βœ… Complete documentation and developer guides
204+
- βœ… Plugin architecture design (ready for implementation)
205+
206+
**What's Coming Next:**
207+
- πŸš€ Dynamic plugin system for easy broker additions
208+
- πŸ“± Mobile app support (iOS and Android)
209+
- πŸ“Š Advanced analytics and reporting
210+
- πŸ”Œ Community-driven broker plugins
211+
- 🌍 Support for more international brokers
212+
- ⚑ Performance optimizations and caching improvements
213+
214+
### What Sponsorship Enables
215+
216+
Your sponsorship directly enables me to:
217+
218+
1. **Dedicate More Time** - Currently, I work on this in evenings and weekends. Sponsorship would allow me to allocate more focused development time.
219+
220+
2. **Faster Broker Integrations** - Each new broker integration requires significant research, API exploration, testing, and documentation. Sponsorship helps prioritize these features.
221+
222+
3. **Better Infrastructure** - Covering costs for CI/CD, testing infrastructure, code signing certificates for native apps, and hosting for documentation.
223+
224+
4. **Community Growth** - Supporting community initiatives, hackathons, and contributor recognition programs.
225+
226+
5. **Long-term Sustainability** - Ensuring Stonks Overwatch remains free, open-source, and privacy-focused for years to come.
227+
228+
### Your Support Makes a Difference
229+
230+
Every contribution, no matter the size, helps sustain this project. Whether you're:
231+
- A casual investor who found value in the tool
232+
- A developer who appreciates the clean architecture
233+
- Someone who believes in privacy-first software
234+
- A company using Stonks Overwatch internally
235+
236+
Your sponsorship shows that open-source, privacy-focused tools matterβ€”and that independent developers can build something meaningful without compromising on values.
237+
238+
### How to Support
239+
240+
**GitHub Sponsors** (Recommended):
241+
πŸ‘‰ [Sponsor me on GitHub](https://github.com/sponsors/ctasada)
242+
243+
**Other Ways to Help:**
244+
- ⭐ **Star the repository** - Helps others discover the project
245+
- πŸ› **Report bugs** - Help improve stability
246+
- πŸ’‘ **Suggest features** - Shape the roadmap
247+
- πŸ“ **Contribute code** - See [Contributing Guide](CONTRIBUTING.md)
248+
- πŸ“’ **Share with others** - Spread the word
249+
250+
---
251+
252+
**Thank you for considering supporting Stonks Overwatch. Your sponsorship helps keep financial privacy accessible to everyone.** πŸ™

β€ŽTHIRD_PARTY_LICENSES.txtβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4034,7 +4034,7 @@ THE SOFTWARE.
40344034

40354035

40364036
platformdirs
4037-
4.5.0
4037+
4.5.1
40384038
MIT
40394039
MIT License
40404040

@@ -4110,7 +4110,7 @@ SOFTWARE.
41104110

41114111

41124112
protobuf
4113-
6.33.1
4113+
6.33.2
41144114
3-Clause BSD License
41154115
Copyright 2008 Google Inc. All rights reserved.
41164116

@@ -5749,7 +5749,7 @@ SOFTWARE.
57495749

57505750

57515751
urllib3
5752-
2.5.0
5752+
2.6.0
57535753
MIT
57545754
MIT License
57555755

β€Ždocs/FAQ.mdβ€Ž

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -410,11 +410,13 @@ Planned features include:
410410

411411
### How can I support the project?
412412

413-
- **Star** the repository on GitHub ⭐
414-
- **Share** with others who might find it useful
415-
- **Contribute** code, documentation, or ideas
416-
- **Report** bugs and suggest improvements
417-
- **Sponsor** development (coming soon)
413+
- **⭐ Star** the repository on GitHub - Helps others discover the project
414+
- **πŸ’° Sponsor** development - [Support via GitHub Sponsors](https://github.com/sponsors/ctasada)
415+
- **πŸ’» Contribute** code, documentation, or ideas - See [Contributing Guide](../CONTRIBUTING.md)
416+
- **πŸ› Report** bugs and suggest improvements - [Open an issue](https://github.com/ctasada/stonks-overwatch/issues)
417+
- **πŸ“’ Share** with others who might find it useful
418+
419+
For more information about sponsorship and why it matters, see the [Support & Sponsorship](Home.md#support--sponsorship) section in the documentation.
418420

419421
---
420422

β€Ždocs/Home.mdβ€Ž

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,41 @@ We welcome contributions! Here's how you can help:
329329

330330
---
331331

332+
## Support & Sponsorship
333+
334+
Stonks Overwatch is a free, open-source project built and maintained by volunteers. Your support helps ensure the project continues to grow and improve.
335+
336+
### Why Sponsor?
337+
338+
Stonks Overwatch was created to solve a real problem: managing investments across multiple brokers while maintaining complete privacy. The project represents over a year of dedicated development work, including:
339+
340+
- Full broker integrations (DEGIRO, Bitvavo, IBKR)
341+
- Native desktop applications for all platforms
342+
- Comprehensive documentation and developer guides
343+
- Privacy-first architecture with local data storage
344+
345+
**Your sponsorship enables:**
346+
- More time dedicated to development and maintenance
347+
- Faster broker integrations and feature development
348+
- Better infrastructure (CI/CD, testing, code signing)
349+
- Long-term sustainability of the project
350+
351+
### How to Support
352+
353+
**GitHub Sponsors** (Recommended):
354+
πŸ‘‰ [Sponsor via GitHub Sponsors](https://github.com/sponsors/ctasada)
355+
356+
**Other Ways to Help:**
357+
- ⭐ **Star the repository** - Helps others discover the project
358+
- πŸ› **Report bugs** - [Open an issue](https://github.com/ctasada/stonks-overwatch/issues)
359+
- πŸ’‘ **Suggest features** - [Request a feature](https://github.com/ctasada/stonks-overwatch/issues/new?template=feature_request.md)
360+
- πŸ“ **Contribute code** - See [Contributing Guidelines](../CONTRIBUTING.md)
361+
- πŸ“’ **Share with others** - Spread the word about Stonks Overwatch
362+
363+
For more details about the project's story and what sponsorship enables, see the [README sponsorship section](https://github.com/ctasada/stonks-overwatch#-why-sponsor-me) on GitHub.
364+
365+
---
366+
332367
## Project Resources
333368

334369
### Links

β€Žpoetry.lockβ€Ž

Lines changed: 18 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
Β (0)