improve docs

Author: rodber

.vuepress/styles/index.styl

@@ -7,3 +7,10 @@
 video {
     object-fit: cover;
 }
+
+.xrdebug-lib-logo {
+    width: 140px;
+    max-width: 100%;
+    max-height: 76px;
+    height: auto;
+}

README.md

@@ -12,17 +12,35 @@ actionLink: /install/
 Apache 2.0 Licensed | Copyright © [Rodolfo Berrios](https://rodolfoberrios.com)
 :::
 
-# Quick start
+# xrDebug
+
+[xrDebug](https://xrdebug.com/) is a lightweight web-based debug software. [Play video](https://xrdebug.com/xrdebug.mp4)
+
+## Quick start
+
+* [Install](/install) server
+
+```sh
+bash <(curl -sL xrdebug.com/bin.sh)
+```
 
-* [Install](/install) command
 * [Run](run/README.md) `xrdebug` to spawn server
+
+```sh
+xrdebug
+```
+
 * Install a client library for your language or use the [HTTP API](./api/) directly
 
 ## Client libraries
 
-To contribute a client library check the [developer guide](/developer) and the [API](/api).
+A client library is a wrapper around the HTTP API.
+
+| Technology | Package                                                   |
+| ---------- | --------------------------------------------------------- |
+| PHP        | [xrdebug/php](https://packagist.org/packages/xrdebug/php) |
+| WordPress  | [xrdebug/wordpress](https://github.com/xrdebug/wordpress) |
+
+## Contributing
 
-| Language                                                          | Package                                                   |
-| ----------------------------------------------------------------- | --------------------------------------------------------- |
-| <img src="./src/tech/php.svg" alt="PHP" width="140"/>             | [xrdebug/php](https://packagist.org/packages/xrdebug/php) |
-| <img src="./src/tech/wordpress.svg" alt="WordPress" width="140"/> | [xrdebug/wordpress](https://github.com/xrdebug/wordpress) |
+If you want to contribute to xrDebug, please check the [developer guide](/developer).

api/README.md

@@ -6,17 +6,15 @@ sidebarDepth: 3
 
 The HTTP API provides a RESTful interface to the server. See the [openapi.yml](https://raw.githubusercontent.com/xrdebug/xrdebug/refs/heads/3.0/api/openapi.yml) file for alternative API documentation.
 
-## Endpoints
-
-### GET /
+## GET /
 
 To access the web interface, open a web browser and navigate to the server's root URL. The server will serve the web interface.
 
 ```sh
 open http://localhost:27420
 ```
 
-### POST /messages
+## POST /messages
 
 Sends a message to the server.
 
@@ -44,7 +42,7 @@ curl --fail -X POST \
     http://localhost:27420/messages
 ```
 
-### POST /pauses
+## POST /pauses
 
 Creates a pause lock.
 
@@ -69,7 +67,7 @@ The following parameters are optional:
 curl --fail -X POST --data "id=123" http://localhost:27420/pauses
 ```
 
-### GET /pauses/{id}
+## GET /pauses/{id}
 
 Retrieves the status of an existing pause lock.
 
@@ -86,7 +84,7 @@ Retrieves the status of an existing pause lock.
 curl --fail -X GET http://localhost:27420/pauses/123
 ```
 
-### DELETE /pauses/{id}
+## DELETE /pauses/{id}
 
 Deletes a pause lock.
 
@@ -103,7 +101,7 @@ Deletes a pause lock.
 curl --fail -X DELETE http://localhost:27420/pauses/123
 ```
 
-### PATCH /pauses/{id}
+## PATCH /pauses/{id}
 
 Updates a pause lock status to `stop: true`.
 
@@ -120,7 +118,7 @@ Updates a pause lock status to `stop: true`.
 curl --fail -X PATCH http://localhost:27420/pauses/123
 ```
 
-### GET /stream
+## GET /stream
 
 Establishes a Server-Sent Events (SSE) connection.
 

developer/README.md

@@ -1,15 +1,25 @@
 ---
-sidebar: false
+sidebar: 3
 ---
 
 # Developer guide
 
-A client library for xrDebug is easy to implement as any HTTP API. Client libraries are HTTP wrappers for interacting with xrDebug, making the configuration and usage trivial to end-users.
+Implementing a client library for xrDebug is straightforward since it's based on standard HTTP APIs. Client libraries act as wrappers around these HTTP endpoints, providing a clean interface that simplifies configuration and usage for end-users.
+
+::: tip Welcome contributions
+If you have an idea for a client library in a language or technology not listed here, please reach out to us. Your contributions help make xrDebug better for everyone.
+:::
 
 ## Design considerations
 
-- The client software is responsible for formatting the debug information.
-- The "ID" field is used to identify messages and pauses. It should be unique for each message or pause, and it's up to the client to generate it.
+- Server doesn't enforce any specific message format and client software is responsible for formatting the debug information. It's recommended to use HTML for messages.
+- "ID" field is used to identify messages and pauses. It should be unique, and it's up to the client to generate it.
+
+Client software **only requires** to handle the following endpoints:
+
+- `POST /messages`
+- `POST /pauses`
+- `GET /pauses/{id}`
 
 ## Message