From 8fee5f01310368c79955573af0d5931fb642de66 Mon Sep 17 00:00:00 2001
From: Curve <fynnbwdt@gmail.com>
Date: Sun, 3 Nov 2024 18:39:04 +0100
Subject: [PATCH] docs: add readme

---
 LICENSE   | 21 +++++++++++++++++++++
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..3c42f29
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Saucer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..52db073
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+<hr>
+
+<div align="center"> 
+    <img src="https://raw.githubusercontent.com/saucer/saucer.github.io/master/static/img/logo.png" height="312" />
+</div>
+
+<p align="center"> 
+    Desktop module for <a href="https://github.com/saucer/saucer">saucer</a>
+</p>
+
+---
+
+## 📦 Installation
+
+* Using [CPM](https://github.com/cpm-cmake/CPM.cmake)
+  ```cmake
+  CPMFindPackage(
+    NAME           saucer-desktop
+    VERSION        1.0.0
+    GIT_REPOSITORY "https://github.com/saucer/desktop"
+  )
+  ```
+
+* Using FetchContent
+  ```cmake
+  include(FetchContent)
+
+  FetchContent_Declare(saucer-desktop GIT_REPOSITORY "https://github.com/saucer/desktop" GIT_TAG v1.0.0)
+  FetchContent_MakeAvailable(saucer-desktop)
+  ```
+
+Finally, link against target:
+
+```cmake
+target_link_libraries(<target> saucer::desktop)
+```
+
+## 📃 Usage
+
+```cpp
+using saucer::modules::desktop::picker::type;
+
+auto app      = saucer::application::acquire(/*...*/);
+auto& desktop = app->add_module<saucer::modules::desktop>();
+
+desktop.open("https://google.com");
+auto file = desktop.pick<type::file>({.filters = {"*.cpp"}});
+```