chore: readme & changelog

README.md

@@ -20,20 +20,24 @@ https://api.sv443.net/geniurl/
 ```
 
 <sub>
-Note that this instance is rate limited to 10 requests within 30 seconds per unique client.
+Note that this instance is rate limited to 5 requests within 15 seconds per unique client.
 </sub>
 
 <br><br>
 
 ## Routes:
-All routes support gzip and deflate compression.
-
+All routes support gzip and deflate compression.  
+  
+Also all routes always return an `error` and `matches` property.  
+They can be used to determine whether a response has succeeded (error = false, matches > 0), is errored (error = true, matches = null) or just didn't yield any results (error = true, matches = 0).  
+  
+These are the available routes:
 - [Search](#get-search)
     - [Search (only top result)](#get-searchtop)
 - [Translations](#get-translationssongid)
 - [Associated Album](#get-albumsongid)
 
-<br>
+<br><br>
 
 > ### GET `/search`
 >
@@ -330,7 +334,7 @@ All routes support gzip and deflate compression.
 >
 > ```json
 > {
->     "error": false,
+>     "error": true,
 >     "matches": 0,
 >     "translations": [],
 >     "timestamp": 1234567890123

changelog.md

@@ -1,5 +1,6 @@
 ## Version History:
-- [**1.3.0**](#v130)
+- [**1.3.1**](#v131)
+- [1.3.0](#v130)
 - [1.2.0](#v120)
 - [1.1.1](#v111)
 - [1.1.0](#v110)
@@ -9,6 +10,14 @@
 
 <br><br>
 
+### v1.3.1
+- Fixed inconsistent `error` property when no translations are found
+- Added support for preflight through an OPTIONS request
+- Improved rate-limit header consistency
+- Made documentation more clear
+
+<br>
+
 ### v1.3.0
 - Added route `/translations/:songId` to receive info about a song's translation pages
 - Added route `/album/:songId` to get info about the album that the provided song is in