Update README.md

Author: alejandrofsevilla

README.md

@@ -1,7 +1,6 @@
 # [![LinuxBuildWorkflow](https://github.com/alejandrofsevilla/boost-tcp-server-client/actions/workflows/LinuxBuild.yml/badge.svg)](https://github.com/alejandrofsevilla/boost-tcp-server-client/actions/workflows/LinuxBuild.yml?event=push) [![TestsWorkflow](https://github.com/alejandrofsevilla/boost-tcp-server-client/actions/workflows/LinuxBuildAndTest.yml/badge.svg)](https://github.com/alejandrofsevilla/boost-tcp-server-client/actions/workflows/LinuxBuildAndTest.yml?event=push)
 # Boost TCP Server/Client
 Asynchronous [Boost.Asio](https://www.boost.org/doc/libs/1_74_0/doc/html/boost_asio.html) TCP server and client example. 
-
 ## Requirements
 - C++17 compiler
 - CMake 3.22.0
@@ -11,10 +10,6 @@ Asynchronous [Boost.Asio](https://www.boost.org/doc/libs/1_74_0/doc/html/boost_a
 ## Usage
 ### Server
 ```cpp
-#include <TcpServer.hpp>
-#include <iostream>
-#include <thread>
-
 struct : TcpServer::Observer {
   void onConnectionAccepted(int id) {
     std::cout << "New client connected with id " << id << std::endl;
@@ -43,10 +38,6 @@ server.startAcceptingConnections();
 ```
 ### Client 
 ```cpp
-#include <TcpClient.hpp>
-#include <iostream>
-#include <thread>
-
 struct : TcpClient::Observer {
   void onConnected() { std::cout << "Client was connected" << std::endl; };
   void onReceived(const char* data, size_t size) {
@@ -67,20 +58,13 @@ TcpClient client{context, observer};
 constexpr uint16_t port{1234};
 auto address{boost::asio::ip::address::from_string("127.0.0.1")};
 client.connect({address, port});
-
 ```
-## How to build
+## Build
 - Install dependencies.
-  - linux 
    ```terminal
    sudo apt-get install libboost-dev
    sudo apt-get install libgtest-dev
    ```
-  - macOs
-   ```terminal
-   brew install boost
-   brew install googletest
-   ```
 - Clone repository.
    ```terminal
    git clone https://github.com/alejandrofsevilla/boost-tcp-server-client.git
@@ -95,3 +79,76 @@ client.connect({address, port});
    ```terminal
    ./build/tests/boost-tcp-server-client-tests 
    ```
+## Implementation
+
+```mermaid
+classDiagram
+    class C_0008186492458287629887["TcpConnection"]
+    class C_0008186492458287629887 {
+        +close() : void
+        -doRead() : void
+        -doWrite() : void
+        +send(const char * data, size_t size) : void
+        +startReading() : void
+        -m_id : int
+        -m_isReading : bool
+        -m_isWritting : bool
+        -m_readBuffer : boost::asio::streambuf
+        -m_socket : boost::asio::ip::tcp::socket
+        -m_writeBuffer : boost::asio::streambuf
+        -m_writeBufferMutex : std::mutex
+    }
+    class C_0009297713916002777393["TcpConnection::Observer"]
+    class C_0009297713916002777393 {
+        +onConnectionClosed(int connectionId) : void
+        +onReceived(int connectionId, const char * data, size_t size) : void
+    }
+    class C_0015464091438354772672["TcpClient"]
+    class C_0015464091438354772672 {
+        +connect(const boost::asio::ip::tcp::endpoint & endpoint) : void
+        +disconnect() : void
+        -onConnectionClosed(int connectionId) : void
+        -onReceived(int connectionId, const char * data, size_t size) : void
+        +send(const char * data, size_t size) : void
+        -m_ioContext : boost::asio::io_context &
+    }
+    class C_0013920056604237995185["TcpClient::Observer"]
+    class C_0013920056604237995185 {
+        +onConnected() : void
+        +onDisconnected() : void
+        +onReceived(const char * data, size_t size) : void
+    }
+    class C_0002490684498279635516["TcpServer"]
+    class C_0002490684498279635516 {
+        +close() : void
+        -doAccept() : void
+        +listen(const boost::asio::ip::tcp & protocol, uint16_t port) : bool
+        -onConnectionClosed(int connectionId) : void
+        -onReceived(int connectionId, const char * data, size_t size) : void
+        +send(int connectionId, const char * data, size_t size) : void
+        +startAcceptingConnections() : void
+        -m_acceptor : boost::asio::ip::tcp::acceptor
+        -m_connectionCount : int
+        -m_isAccepting : bool
+        -m_isClosing : bool
+    }
+    class C_0004458731545202809661["TcpServer::Observer"]
+    class C_0004458731545202809661 {
+        +onConnectionAccepted(int connectionId) : void
+        +onConnectionClosed(int connectionId) : void
+        +onReceived(int connectionId, const char * data, size_t size) : void
+    }
+    C_0008186492458287629887 --> C_0009297713916002777393 : -m_observer
+    C_0008186492458287629887 ()-- C_0009297713916002777393 : 
+    C_0015464091438354772672 --> C_0008186492458287629887 : -m_connection
+    C_0015464091438354772672 --> C_0013920056604237995185 : -m_observer
+    C_0015464091438354772672 ()-- C_0013920056604237995185 : 
+    C_0002490684498279635516 o-- C_0008186492458287629887 : -m_connections
+    C_0002490684498279635516 --> C_0004458731545202809661 : -m_observer
+    C_0002490684498279635516 ()-- C_0004458731545202809661 : 
+    C_0009297713916002777393 <|-- C_0015464091438354772672 : 
+    C_0009297713916002777393 <|-- C_0002490684498279635516 : 
+
+%% Generated with clang-uml, version 0.6.0
+%% LLVM version Ubuntu clang version 15.0.
+```