docs: update readme

Author: Curve

README.md

@@ -1,112 +1,58 @@
 <div align="center"> 
-    <img src="assets/logo.png" height=312>
+    <img src="assets/logo.svg" height=312>
 </div>
 
 <br/>
 
-<p align="center"> 
-    A C++20 library that provides mutex protection for any object
+<p align="center">
+    A C++20 library providing mutex protection for any object
 </p>
 
----
+## 📦 Installation
 
-## ⚙️ Configuration
-### Tests
-```cmake
-set(lockpp_tests OFF)
-```
-> If set to `ON`, lockpp will build tests.
-
-
-## 📎 Installation
-
-> **Note**  
-> This library requires a C++20 capable compiler.
-> In case you need support for C++17 checkout [version 1.0.2](https://github.com/Soundux/lockpp/releases/tag/v1.0.2)
-
-- FetchContent
-
-    ```cmake
-    include(FetchContent)
-    FetchContent_Declare(lockpp GIT_REPOSITORY "https://github.com/Soundux/lockpp")
+* Using [CPM](https://github.com/cpm-cmake/CPM.cmake)
+  ```cmake
+  CPMFindPackage(
+    NAME           lockpp
+    VERSION        2.3
+    GIT_REPOSITORY "https://github.com/Soundux/lockpp"
+  )
+  ```
 
-    FetchContent_MakeAvailable(lockpp)
-    target_link_libraries(<YourLibrary> lockpp)
-    ```
+* Using FetchContent
+  ```cmake
+  include(FetchContent)
 
-- Git Submodule
+  FetchContent_Declare(lockpp GIT_REPOSITORY "https://github.com/Soundux/lockpp" GIT_TAG v2.3)
+  FetchContent_MakeAvailable(lockpp)
 
-    ```bash
-    git submodule add "https://github.com/Soundux/lockpp"
-    ```
-    ```cmake
-    # Somewhere in your CMakeLists.txt
-    add_subdirectory("<path_to_lockpp>")
-    target_link_libraries(<YourLibrary> lockpp)
-    ```
+  target_link_libraries(<target> lockpp)
+  ```
 
-## 📔 Usage
+## 📃 Usage
 
-### Simple example
 ```cpp
-#include <lockpp/lock.hpp>
+lockpp::lock<std::string> var("Test");
 
-int main()
+// Read only access
 {
-    lockpp::lock<std::string> protected_string("Test");
-    {
-        auto read_access = protected_string.read();
-        bool is_empty = read_access->empty();
-        // read_access->clear(); <-- Will not work
-    }
-    {
-        auto write_access = protected_string.write();
-
-        write_access->clear();
-        *write_access = "New String!";
-
-        // auto another_write_access = protected_string.write(); <-- This will lock.
-    }
-
-    return 0;
+    auto locked = var.read();
+    assert(!locked->empty());
 }
-```
 
-### Custom Mutex
-```cpp
-#include <lockpp/lock.hpp>
-
-int main()
+// Write access
 {
-    lockpp::lock<std::string, std::recursive_mutex> protected_string("Test");
-    {
-        auto write_access = protected_string.write();
-
-        write_access->clear();
-        *write_access = "New String!";
-
-        auto another_write_access = protected_string.write();
-        *another_write_access = "This is fine!";
-    }
+    auto locked = var.write();
 
-    return 0;
+    *write_access = "assignment";
+    locked->clear();
 }
-```
-
-### Custom Locks
-```cpp
-#include <lockpp/lock.hpp>
-
-int main()
-{
-    lockpp::lock<std::string> protected_string("Test");
-    {
-        auto read_1 = test.read<std::unique_lock>();
-        auto read_2 = test.read<std::unique_lock>(std::adopt_lock); // <-- Also accepts custom arguments for lock
-    }
 
-    return 0;
-}
+// One time access
+var.assign("another assignment");
+assert(var.copy() == "another assignment");
 ```
 
-> For more examples see [tests](tests/)
+_lockpp_ also allows you to [supply the mutex to be used](tests/custom-mutex.cpp) as well [as custom locks](tests/custom-lock.cpp) _(i.e `std::unique_lock`, `std::lock_guard`)_.
+
+> For more examples see [tests](tests)