Update README.md
This commit is contained in:
parent
a11c8e6004
commit
cbaa076fb1
40
README.md
40
README.md
@ -7,7 +7,7 @@
|
||||
[](https://git.intelgx.com/Intelgx/IlearnQuranTesting/releases)
|
||||
[](https://reactnative.dev/)
|
||||
[](https://www.typescriptlang.org/)
|
||||
[](https://ilearnquran.org)
|
||||
[](LICENSE)
|
||||
|
||||
[Download APK](https://git.intelgx.com/Intelgx/IlearnQuranTesting/releases/download/IlearnQuran/IlearnQuran-release-v1.0.6-1.apk) • [Website](https://ilearnquran.org) • [Report Bug](https://github.com/anthropics/claude-code/issues)
|
||||
|
||||
@ -89,7 +89,7 @@
|
||||
### Prerequisites
|
||||
|
||||
- **Node.js** >= 18
|
||||
- **Yarn** 4.7.0 or npm
|
||||
- **Bun** (latest version) or npm
|
||||
- **React Native CLI**
|
||||
- **Android Studio** (for Android development)
|
||||
- **Xcode** (for iOS development, macOS only)
|
||||
@ -104,7 +104,7 @@
|
||||
|
||||
2. **Install dependencies**
|
||||
```bash
|
||||
yarn install
|
||||
bun install
|
||||
# or
|
||||
npm install
|
||||
```
|
||||
@ -118,7 +118,7 @@
|
||||
|
||||
4. **Start Metro bundler**
|
||||
```bash
|
||||
yarn start
|
||||
bun start
|
||||
# or
|
||||
npm start
|
||||
```
|
||||
@ -127,14 +127,14 @@
|
||||
|
||||
**For Android:**
|
||||
```bash
|
||||
yarn android
|
||||
bun run android
|
||||
# or
|
||||
npm run android
|
||||
```
|
||||
|
||||
**For iOS:**
|
||||
```bash
|
||||
yarn ios
|
||||
bun run ios
|
||||
# or
|
||||
npm run ios
|
||||
```
|
||||
@ -143,17 +143,17 @@
|
||||
|
||||
```bash
|
||||
# Development
|
||||
yarn start # Start Metro bundler
|
||||
yarn android # Run on Android
|
||||
yarn ios # Run on iOS
|
||||
bun start # Start Metro bundler
|
||||
bun run android # Run on Android
|
||||
bun run ios # Run on iOS
|
||||
|
||||
# Testing
|
||||
yarn test # Run tests
|
||||
yarn lint # Run ESLint
|
||||
bun test # Run tests
|
||||
bun run lint # Run ESLint
|
||||
|
||||
# Production
|
||||
yarn build:android # Build Android APK
|
||||
yarn build:ios # Build iOS IPA
|
||||
bun run build:android # Build Android APK
|
||||
bun run build:ios # Build iOS IPA
|
||||
```
|
||||
|
||||
---
|
||||
@ -350,7 +350,13 @@ This program is designed to help you learn the correct recitation of the Holy Qu
|
||||
|
||||
## 📜 License
|
||||
|
||||
This project is free to use for educational and religious purposes. For commercial use or investment opportunities, please contact the project founder.
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
---
|
||||
|
||||
@ -368,7 +374,11 @@ This project is free to use for educational and religious purposes. For commerci
|
||||
|
||||
**Made with ❤️ for the Muslim Ummah**
|
||||
|
||||
*"The best among you are those who learn the Quran and teach it." - Prophet Muhammad (ﷺ)*
|
||||
*"The best among you are those who learn the Quran and teach it."*
|
||||
|
||||
*"خَيْرُكُمْ مَنْ تَعَلَّمَ الْقُرْآنَ وَعَلَّمَهُ"*
|
||||
|
||||
**- Prophet Muhammad (ﷺ)**
|
||||
|
||||
[⬆ Back to Top](#ilearn-quran-)
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user