docs: remove auto text formatting

UNTalent · Feb 23, 2023 · 732ceca · 732ceca
1 parent 0c64243
commit 732ceca
Showing 1 changed file with 13 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -10,13 +10,11 @@ Displays the list of all ratings available.
 
 ```javascript
 {
-   "ratings"
-:
-   [
+   "ratings": [
       {
          "title": "Pay attention", // The title of the rating
          "description": "This source has content that may or may not be legit",
-         "is_dangerous": false | true, // Whether the source is dangerous or not. Available if probability is high enough
+         "is_dangerous": false|true, // Whether the source is dangerous or not. Available if probability is high enough
          "level": 0.5 // A number between 0 (scam) and 1 (reliable)
       },
       ...
@@ -30,38 +28,17 @@ Returns the rating for an email address or a domain name (an url without path).
 
 ```javascript
 {
-   "is_analysed"
-:
-   true, // Whether the domain has an analysis or not
-           "domain"
-:
-   {
-      "host"
-   :
-      "unicef.org", // The extracted host
-              "analysis"
-   :
-      { // Analysis for that domain, if is_analysed is true
-         "rating"
-      :
-         { // The rating of the analysis
-            "title"
-         :
-            "Official source",
-                    "description"
-         :
-            "This address is an official source that you can trust.",
-                    "is_dangerous"
-         :
-            false,
-                    "level"
-         :
-            0.99
-         }
-      ,
-         "title"
-      :
-         "Official UN website" // A title for the analysis
+   "is_analysed": true, // Whether the domain has an analysis or not
+   "domain": {
+      "host": "unicef.org", // The extracted host
+      "analysis": { // Analysis for that domain, if is_analysed is true
+         "rating": { // The rating of the analysis
+            "title": "Official source",
+            "description": "This address is an official source that you can trust.",
+            "is_dangerous": false,
+            "level": 0.99
+         },
+         "title": "Official UN website" // A title for the analysis
       }
    }
 }