diff --git a/README.md b/README.md index 9f48078..9e353a8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ -# quran-api +# Quran API | واجهة القرآن -واجهة برمجية للقرآن الكريم - Quran REST API with Arabic tafsir \ No newline at end of file +RESTful API for the Holy Quran. + +## Endpoints +- GET /surahs - All 114 surahs +- GET /surahs/{id} - Surah detail +- GET /search?q= - Search + +```bash +pip install -r requirements.txt +python main.py +``` + +Built on GitPasha \ No newline at end of file