From ceb1d5deceabc6ff4f383ecffc21e6a5cdd118d9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Robin=20Lind=C3=A9n?= <dev@robinlinden.eu>
Date: Thu, 25 Apr 2019 21:22:16 +0200
Subject: [PATCH] Add information about the project

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ea0cf0c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# libsodium-cmake
+
+## Description
+
+CMakeWrapper for [libsodium](https://github.com/jedisct1/libsodium), the modern, portable, easy to use crypto library.
+
+This wrapper is written with a few goals in mind:
+1. It should be easy to build
+1. It should be obvious that libsodium's source code hasn't been touched
+1. It should be easy to integrate into projects
+
+## Building
+
+Clone!
+
+`git clone --recursive https://github.com/robinlinden/libsodium-cmake.git`
+
+Build!
+
+```sh
+mkdir build && cd build
+cmake ..
+make
+make test
+```
+
+## Using in your project
+
+```cmake
+FetchContent_Declare(
+    Sodium
+    GIT_REPOSITORY https://github.com/robinlinden/libsodium-cmake.git
+)
+
+FetchContent_GetProperties(Sodium)
+if(NOT sodium_POPULATED)
+    FetchContent_Populate(Sodium)
+    add_subdirectory(
+        ${sodium_SOURCE_DIR}
+        ${sodium_BINARY_DIR}
+    )
+endif()
+
+target_link_libraries(${PROJECT_NAME}
+    PRIVATE
+        sodium
+)
+```