Skip to content

Commit 73fc9ca

Browse files
chore - sponsor documentation (#11)
* chore(docs): updating docs * chore(docs): updating docs
1 parent 388d193 commit 73fc9ca

File tree

2 files changed

+116
-1
lines changed

2 files changed

+116
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
A React Native library for tracking location in the background using TurboModules (New Architecture). Track user location even when the app is minimized or in the background.
2020

21-
<video src="docs/assets/tracking.mp4" controls muted playsinline loop width="100%"></video>
21+
![Tracking demo](docs/assets/tracking.gif)
2222

2323
## Features
2424

@@ -512,6 +512,19 @@ Make sure your `tsconfig.json` includes:
512512

513513
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
514514

515+
## Support & Sponsorship
516+
517+
If you find this library useful, please consider:
518+
519+
-**Star the repository** - It helps others discover the project
520+
- 🐛 **Report bugs** - Help me improve the library
521+
- 💻 **Contribute code** - Pull requests are always welcome
522+
-**Sponsor on GitHub** - Support ongoing development and maintenance
523+
524+
[**Sponsor this project**](https://github.com/sponsors/gabriel-sisjr) to help me continue building and maintaining open source tools for the React Native community.
525+
526+
See the [Sponsor page](SPONSOR.md) for more details about sponsorship benefits and how your support helps the project.
527+
515528
## License
516529

517530
MIT

SPONSOR.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Sponsor this project
2+
3+
## 🙏 Support `@gabriel-sisjr/react-native-background-location`
4+
5+
**react-native-background-location** is an open source library for React Native that enables background location tracking using TurboModules (New Architecture). This project is maintained with dedication to provide a reliable and performant solution for developers who need to track location even when the app is in the background.
6+
7+
## 🚀 About the Project
8+
9+
This library offers:
10+
11+
-**Background location tracking** - Continues tracking when the app is minimized
12+
-**Real-time updates** - Automatic event-driven location monitoring system
13+
-**TurboModule** - Built with React Native's New Architecture for better performance
14+
-**Session-based tracking** - Organizes location data by trip/session IDs
15+
-**Full TypeScript support** - Fully typed API
16+
-**Android support** - Native Kotlin implementation (iOS coming soon)
17+
-**Persistent storage** - Locations are stored and survive app restarts
18+
-**Foreground service** - Uses Android foreground service for reliable tracking
19+
20+
## 💝 Why sponsor?
21+
22+
By sponsoring this project, you are:
23+
24+
- 🎯 **Supporting continuous development** of an essential tool for the React Native community
25+
- 📱 **Accelerating iOS implementation** - One of the priority goals in the roadmap
26+
- 🔧 **Enabling improvements** such as geofencing, distance filtering, battery optimization, and more
27+
- 🐛 **Ensuring quick bug fixes** and community support
28+
- 📚 **Improving documentation** and creating more examples and tutorials
29+
- 🧪 **Maintaining high quality** through comprehensive tests and CI/CD
30+
31+
## 🎁 How your sponsorship will be used
32+
33+
- **Active development**: Implementation of new features and improvements
34+
- **Maintenance**: Bug fixes and compatibility updates
35+
- **Documentation**: Creation and improvement of guides and examples
36+
- **Infrastructure**: CI/CD costs, hosting, and development tools
37+
- **Support**: Community assistance and issue resolution
38+
39+
## 🏆 Benefits for Sponsors
40+
41+
As a sponsor, you can expect:
42+
43+
- 📢 **Public recognition** in the project's README
44+
-**Priority in issues** and feature requests
45+
- 💬 **Direct access** for roadmap and priority discussions
46+
- 🎯 **Mentoring and technical support** for library integration
47+
- 📖 **Customized documentation** for specific use cases
48+
49+
## 🤝 How to become a sponsor
50+
51+
You can become a sponsor through [GitHub Sponsors](https://github.com/sponsors/gabriel-sisjr).
52+
53+
Click the **Sponsor** button at the top of this page or visit directly:
54+
55+
👉 **[https://github.com/sponsors/gabriel-sisjr](https://github.com/sponsors/gabriel-sisjr)**
56+
57+
## 📊 Project Impact
58+
59+
- 📦 **Published on npm** as `@gabriel-sisjr/react-native-background-location`
60+
-**Used by developers** in React Native applications around the world
61+
- 🔄 **Active development** with regular releases and continuous improvements
62+
- 🧪 **High quality** with test coverage and professional CI/CD
63+
- 📚 **Complete documentation** with detailed guides and practical examples
64+
65+
## 🛣️ Roadmap
66+
67+
With your support, we can accelerate:
68+
69+
- [ ] iOS implementation with Swift
70+
- [ ] Customizable location update intervals
71+
- [ ] Geofencing support
72+
- [ ] Distance filtering for GPS coordinates
73+
- [ ] SQLite storage option for large datasets
74+
- [ ] Configurable notification appearance
75+
- [ ] Battery optimization modes
76+
- [ ] Web support (Geolocation API)
77+
78+
## 📝 Other ways to contribute
79+
80+
Can't sponsor financially? No problem! You can contribute in other ways:
81+
82+
-**Give a star** to the repository
83+
- 🐛 **Report bugs** or suggest improvements
84+
- 💻 **Contribute code** - Pull requests are always welcome
85+
- 📖 **Improve documentation** - Fixes and new examples
86+
- 💬 **Share** the project with other developers
87+
- 🧪 **Test** new versions and provide feedback
88+
89+
See our [contributing guide](CONTRIBUTING.md) for more details.
90+
91+
## 🙌 Acknowledgments
92+
93+
We thank all sponsors and contributors who make this project possible. Your generosity and support are essential to maintaining and improving this library for the entire React Native community.
94+
95+
---
96+
97+
**Thank you for considering sponsoring this project!** 🎉
98+
99+
---
100+
101+
_For more information about the project, visit the [README](README.md) or the [complete documentation](docs/README.md)._
102+

0 commit comments

Comments
 (0)