Update README
This commit is contained in:
parent
79138c69a7
commit
cbb7e3e11b
1 changed files with 7 additions and 11 deletions
18
README.md
18
README.md
|
@ -1,8 +1,7 @@
|
||||||
## About
|
## About
|
||||||
|
|
||||||
This repository contains The Noble Quran, and multiple
|
This repository contains The Noble Quran in its original Arabic,
|
||||||
translations that have been sourced from https://quran.com,
|
alongside multiple translations.
|
||||||
and https://www.searchtruth.com.
|
|
||||||
|
|
||||||
## share/
|
## share/
|
||||||
|
|
||||||
|
@ -16,15 +15,12 @@ and https://www.searchtruth.com.
|
||||||
|
|
||||||
See [Surah Al-Fatihah (English)](share/quran-json/TheQuran/en/1.json) for an example
|
See [Surah Al-Fatihah (English)](share/quran-json/TheQuran/en/1.json) for an example
|
||||||
|
|
||||||
## Usage
|
## Install
|
||||||
|
|
||||||
# Clone
|
user@localhost$ git clone https://github.com/ReflectsLight/quran-json
|
||||||
git clone https://github.com/ReflectsLight/quran-json
|
user@localhost$ cd quran-json
|
||||||
cd quran-json
|
user@localhost$ bundle install
|
||||||
|
user@localhost$ bundle exec ruby bin/quran-json --help
|
||||||
# Install
|
|
||||||
bundle install
|
|
||||||
bundle exec ruby bin/quran-json --help
|
|
||||||
|
|
||||||
## Thanks
|
## Thanks
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue