update texts

Author: husayt

CHANGELOG.md

@@ -7,9 +7,6 @@ All notable changes to this project will be documented in this file. See [standa
 
 [compare changes](https://git+https@github.com/quran-center/quran-meta/compare/v4.0.2...v4.0.3)
 
-## v4.0.2
-
-[compare changes](https://git+https@github.com/quran-center/quran-meta/compare/v4.0.1...v4.0.2)
 
 ### 🏡 Chore
 
@@ -25,6 +22,18 @@ All notable changes to this project will be documented in this file. See [standa
 
 **Breaking changes in this version**
 
+We apologize for any inconvenience caused by the recent breaking changes. These updates were essential to ensure safer and more error-free development in the future. The primary reasons for these changes include:
+
+- Enhancing type safety to prevent errors.
+- Providing clear and predictable behavior.
+
+By leveraging TypeScript and proper type usage, many issues can be identified early, saving users from encountering hard-to-find errors later on.
+
+
+* Number of functions have been renamed to be consistent
+* `findSurahByAyahId` renamed to `findSurahAyahByAyahId` and new `findSurahAyahByAyahId` is different
+* check for other changes
+
 ### 🚀 Enhancements
 
 - Add new Surah String Parser `surahStringParser` (6620546)

README.md

@@ -1,7 +1,7 @@
 Quran Meta
 ==========
 
-[![Static Badge](https://img.shields.io/badge/Quran-Meta-brightgreen)](https://moiva.io/?npm=quran-meta)
+[![Static Badge](https://img.shields.io/badge/Quran-Meta-brightgreen)](https://github.com/quran-center/quran-meta)
 [![Static Badge](https://img.shields.io/badge/Documentation-blue)](https://quran-center.github.io/quran-meta/docs/)
 
 [![GitHub License](https://img.shields.io/github/license/quran-center/quran-meta)](https://github.com/quran-center/quran-meta/blob/master/LICENSE) 
@@ -54,10 +54,10 @@ Answering Questions like:
   * juz  (`findJuzMetaBySurah`)
   * maqra/rub-el-hizb  (`getRubAlHizbMeta`, `getRubAlHizbMetaByAyahId`)
 * Validates ayah/surah id (`checkValidAyahId`,`checkValidSurah`, `checkValidSurahAyah`) 
-* Typescript type guards (`isValidAyahId`, `isValidAyahNo`, `isValidSurah`, `isValidSurahAyah`, `isValidJuz`, `isValidHizb`, `isValidRubAlHizb`, `isValidPage` and ``)
+* Typescript type guards (`isValidAyahId`, `isValidAyahNo`, `isValidSurah`, `isValidSurahAyah`, `isValidJuz`, `isValidHizb`, `isValidRubAlHizb`, `isValidPage`)
 * converts `[surah, ayah]` to `ayahId` and vice-verse ( `findSurahByAyahId` and  `findAyahIdBySurah`) 
-* Checks and turns strings of type "x:y" or "x:y1-y2" to surah/ayah range `ayaStringSplitter`.
-* Checks and parses strings of type "x"  to Surah `surahStringParser`.
+* Checks and turns strings of type "x:y" or "x:y1-y2" to surah/ayah range (`ayaStringSplitter`).
+* Checks and parses strings of type "x"  to Surah (`surahStringParser`).
 
 ### APi Reference Documentation