From 87e130bc7b7b26e820b96feef156afeb07c01029 Mon Sep 17 00:00:00 2001
From: Paul Hariel <paul.hariel@outlook.com>
Date: Wed, 27 Sep 2023 15:11:11 +0200
Subject: [PATCH] Update README.md

---
 .github/workflows/doxygen.yml |  2 +-
 README.md                     | 33 ++++++++++++++++++++++++++++-----
 2 files changed, 29 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml
index 5b872df..10a80a0 100644
--- a/.github/workflows/doxygen.yml
+++ b/.github/workflows/doxygen.yml
@@ -2,7 +2,7 @@ on:
   workflow_dispatch:
   push:
     branches:
-    - docs
+    - asio
 
 name: Build doxygen documentation
 jobs:
diff --git a/README.md b/README.md
index b87ff87..41e08c5 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,31 @@
 # Pine
 
-Pine is a modern and lightweight Windows chat/forum application built with the
-[Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk/), and
-[WinUI3](https://docs.microsoft.com/windows/apps/winui/winui3/).
+Pine is a modern and lightweight C++20 library for building chat applications.
 
-Server side is built on
-[WinSocks2](https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-start-page-2).
\ No newline at end of file
+It uses its own protocol, which is based on TCP using asio. Therefore, it is 
+not suitable for use on the web.
+
+It is multi-threaded and uses asynchronous I/O, and is designed to be
+easily extensible.
+
+## Building
+
+_Build will not work if using clang_
+
+It is recommended to use [vcpkg](https://github.com/microsoft/vcpkg) to install
+dependencies. Pine uses CMake as its build system. To build Pine, run the
+following commands:
+
+Dependencies:
+
+```bash
+vcpkg install asio:x64-windows gtest:x64-windows
+vcpkg install asio:x64-linux gtest:x64-linux
+```
+
+```bash
+mkdir build
+cd build
+cmake .. -DCMAKE_TOOLCHAIN_FILE=<path to vcpkg>/scripts/buildsystems/vcpkg.cmake
+cmake --build .
+```