README.md redacted

README.md

@@ -0,0 +1,50 @@
+# ORB - (Open React Blog) API
+
+Little API for access to Open React Blog's data.
+
+Base URL: [https://open-react-blog-api.herokuapp.com](https://open-react-blog-api.herokuapp.com)
+
+## Available endpoints
+
+- `/user` - Get determinated user data
+    
+    Details:
+    - **GET Request**
+    - Request's Body:
+        ```json
+        {
+            "user": "example" //!REQUIRED
+        }
+        ```
+    - Returned Data:
+        ```json
+        {
+            "username": {
+                "username": "john-doe",
+                "displayUsername": "John Doe"
+            },
+            "posts": [
+                {
+                    "id": "id",
+                    "data": {
+                        "readingTime": "1 min.",
+                        "title": "Lorem Ipsum",
+                    },
+                    "date": {
+                        "seconds": 1651334551
+                    },
+                    "post": "Full post",
+                    "shortPost": "Full p..."
+                }
+            ]
+        }
+        ```
+
+## Acknowledgments
+
+**Fonts**
+- [Poppins](https://fonts.google.com/specimen/Poppins)
+- [Be Vietnam Pro](https://fonts.google.com/specimen/Be+Vietnam+Pro)
+
+**Libraries**
+- [highlight.js](https://highlightjs.org/)