summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoraltaf-creator <64111012+altaf-creator@users.noreply.github.com>2023-05-11 21:33:19 +0700
committeraltaf-creator <64111012+altaf-creator@users.noreply.github.com>2023-05-11 21:33:19 +0700
commit94b6c31246e180462ebb105487bfc4fa28ac1f39 (patch)
tree5279afb2c32259a005029e613463a47bb2eb7d7d
parent9224d5d122edd619be16c10cb3e5c75af164a59b (diff)
Add README
-rw-r--r--README.md51
-rw-r--r--readme-assets/screenshots/1.pngbin0 -> 66650 bytes
-rw-r--r--readme-assets/screenshots/2.pngbin0 -> 68455 bytes
-rw-r--r--readme-assets/screenshots/3.pngbin0 -> 103985 bytes
-rw-r--r--readme-assets/screenshots/4.pngbin0 -> 52233 bytes
5 files changed, 51 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4534072
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# OpenQuran
+<img src="src/images/favicon.png" width="250px" align="right">
+
+ِبِسْمِ اللَّهِ الرَّحْمَنِ الرَّحِيْم
+
+السَّلاَمُ عَلَيْكُمْ وَرَحْمَةُ اللهِ وَبَرَكَاتُهُ
+
+OpenQuran is an online & offline (for Windows) Al-Qur'an Reader website & app.
+
+## Features
+---
+
+- Al-Qur'an
+- Sura List
+- Translation
+ - English
+ - Indonesia
+
+## Installation
+---
+
+### Download from Releases (Windows)
+1. Download the .zip file [here](https://github.com/altaf-creator/OpenQuran/releases/tag/v1.0.0)
+2. Unzip the file
+3. Open the `OpenQuran` shortcut on the unzipped root folder **OR** navigate to `\OpenQuran-win32-x64` then open `OpenQuran.exe`
+
+### Compile using Electron Forge
+1. Clone the repository using `git clone https://github.com/altaf-creator/OpenQuran.git`
+2. Navigate to OpenQuran
+3. Install dependencies using `npm install`
+4. To preview your electron app, run `npm start`
+5. To build your electron app, run `npm run start`
+
+### Add to Homescreen (Browser)
+1. Open OpenQuran's website [here](https://altaf-creator.github.io/OpenQuran/)
+2. Click your browser's menu (usually ⋯)
+3. Click "Add to Homescreen" or "Install App"
+
+## Screenshots
+---
+
+![screenshot 1](readme-assets/screenshots/1.png)
+![screenshot 2](readme-assets/screenshots/2.png)
+![screenshot 3](readme-assets/screenshots/3.png)
+![screenshot 4](readme-assets/screenshots/4.png)
+
+
+## Credits & Attribution
+---
+- [The Tanzil Project](https://tanzil.net)
+- [Made with Electron](https://www.electronjs.org/) \ No newline at end of file
diff --git a/readme-assets/screenshots/1.png b/readme-assets/screenshots/1.png
new file mode 100644
index 0000000..4ba265b
--- /dev/null
+++ b/readme-assets/screenshots/1.png
Binary files differ
diff --git a/readme-assets/screenshots/2.png b/readme-assets/screenshots/2.png
new file mode 100644
index 0000000..c521dc9
--- /dev/null
+++ b/readme-assets/screenshots/2.png
Binary files differ
diff --git a/readme-assets/screenshots/3.png b/readme-assets/screenshots/3.png
new file mode 100644
index 0000000..1245395
--- /dev/null
+++ b/readme-assets/screenshots/3.png
Binary files differ
diff --git a/readme-assets/screenshots/4.png b/readme-assets/screenshots/4.png
new file mode 100644
index 0000000..7ea65ae
--- /dev/null
+++ b/readme-assets/screenshots/4.png
Binary files differ