ReflectsLight/quran-json
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: update

Browse source
This commit is contained in:
0x1eef 2023-12-04 11:20:23 -03:00
parent d75b511adc
commit af5cf89467
1 changed files with 5 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,15 +1,11 @@
<p align="left"> ## About
<strong>About</strong>
</p>
quran-json is a dual purpose project where on the one hand it provides a quran-json is a dual purpose project where on the one hand it provides a
command-line utility for downloading the content of The Quran in multiple command-line utility for downloading the content of The Quran in multiple
languages, and on the other hand it provides a copy of the content that languages, and on the other hand it provides a copy of the content that
can be downloaded. The content is provided in the JSON format. can be downloaded. The content is provided in the JSON format.
<p align="left"> ## share/
<strong>share/</strong>
</p>
* [share/quran-json/TheQuran/ar/](share/quran-json/TheQuran/ar/) contains The Quran in its original Arabic. * [share/quran-json/TheQuran/ar/](share/quran-json/TheQuran/ar/) contains The Quran in its original Arabic.
* [share/quran-json/TheQuran/en/](share/quran-json/TheQuran/en/) contains an English translation of The Quran. * [share/quran-json/TheQuran/en/](share/quran-json/TheQuran/en/) contains an English translation of The Quran.
@ -33,9 +29,7 @@ content of the ayah.
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.
<p align=left"> ## bin/
<strong>bin/</strong>
</p>
The [bin/quran-json](bin/quran-json) executable is a utility for downloading The [bin/quran-json](bin/quran-json) executable is a utility for downloading
the content of The Quran in multiple languages. the content of The Quran in multiple languages.
@ -49,9 +43,7 @@ Usage: quran-json pull [OPTIONS]
-u, --update Update surah metadata -u, --update Update surah metadata
</pre> </pre>
<p align="left"> ## Thanks
<strong>Thanks</strong>
</p>
First and foremost, Alhamdulillah. First and foremost, Alhamdulillah.
@ -68,9 +60,7 @@ And thanks to the translators of the content:
* _Muhammad Hamidullah_ for the French translation. * _Muhammad Hamidullah_ for the French translation.
* _Hamza Roberto Piccardo_ for the Italian translation. * _Hamza Roberto Piccardo_ for the Italian translation.
<p align="left"> ## License
<strong>License</strong>
</p>
The "source code" is released under the [GPL](./LICENSE) license. The "source code" is released under the [GPL](./LICENSE) license.
<br> <br>