Skip to content

Commit e88a905

Browse files
authored
chore: Update readme (#1)
1 parent d92551e commit e88a905

File tree

1 file changed

+47
-31
lines changed

1 file changed

+47
-31
lines changed

README.md

Lines changed: 47 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,66 @@
1-
# Welcome to your Expo app 👋
1+
# DBReader (Kaizoku)
22

3-
This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
3+
A modern Real-Debrid client for managing torrents and downloads.
44

5-
## Get started
5+
## What is DBReader?
66

7-
1. Install dependencies
7+
DBReader is a mobile application built for [Real-Debrid](https://real-debrid.com), a premium file hosting service. This app allows you to:
88

9-
```bash
10-
npm install
11-
```
9+
- Add magnet links to Real-Debrid
10+
- Monitor torrent downloads on Real-Debrid servers
11+
- Unrestrict links for direct access
12+
- Download the resulting files to your device
1213

13-
2. Start the app
14+
## Getting Started
1415

15-
```bash
16-
npx expo start
17-
```
16+
### Setting Up Real-Debrid API Access
1817

19-
In the output, you'll find options to open the app in a
18+
1. Visit https://real-debrid.com/apitoken
19+
2. Click "Click here to generate a client ID for open source applications"
20+
3. Save the generated client_id
21+
4. In the app's settings screen, follow the instructions to authenticate with Real-Debrid
2022

21-
- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
22-
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
23-
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
24-
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo
23+
## Features
2524

26-
You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
25+
- **Torrent Management**: Add magnets, monitor progress, select files
26+
- **Download Management**: Download files directly to your device
27+
- **Progress Tracking**: Monitor download status with notifications
28+
- **Media Handling**: Stream content directly from Real-Debrid
2729

28-
## Get a fresh project
30+
## Technology Stack
2931

30-
When you're ready, run:
32+
- React Native / Expo
33+
- TypeScript
34+
- Zustand for state management
35+
- React Query for API data fetching
36+
- React Native Paper for UI components
3137

32-
```bash
33-
npm run reset-project
34-
```
38+
## Contributing
3539

36-
This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.
40+
1. Fork the repository
41+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
42+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
43+
4. Push to the branch (`git push origin feature/amazing-feature`)
44+
5. Open a Pull Request
3745

38-
## Learn more
46+
## Legal Disclaimer
3947

40-
To learn more about developing your project with Expo, look at the following resources:
48+
**IMPORTANT**: DBReader is intended for legal use only. The application should only be used to download and manage content that you have the legal right to access.
4149

42-
- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
43-
- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.
50+
The developer of this application:
4451

45-
## Join the community
52+
- Does not host, store, or distribute any content
53+
- Is not responsible for how users utilize this software
54+
- Cannot be held liable for any laws broken by users of this application
55+
- Does not endorse or encourage illegal activities of any kind
4656

47-
Join our community of developers creating universal apps.
57+
By using this application, you agree that you are solely responsible for complying with all applicable copyright laws and regulations in your jurisdiction.
4858

49-
- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute.
50-
- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions.
59+
## License
60+
61+
This project is licensed under the MIT License - see the LICENSE file for details.
62+
63+
## Acknowledgments
64+
65+
- [Real-Debrid](https://real-debrid.com) for their API
66+
- [Expo](https://expo.dev) for the React Native development framework

0 commit comments

Comments
 (0)