From 7d2fd76b5b85fa66cc7235a80e93d8ac666a788a Mon Sep 17 00:00:00 2001
From: Sukera <Seelengrab@users.noreply.github.com>
Date: Mon, 18 Mar 2024 09:11:23 +0100
Subject: [PATCH] Add docstring to main module

---
 src/Supposition.jl | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/Supposition.jl b/src/Supposition.jl
index 974deae..c96d682 100644
--- a/src/Supposition.jl
+++ b/src/Supposition.jl
@@ -1,3 +1,19 @@
+"""
+    Supposition.jl
+
+Supposition.jl is a fuzzing & property based testing (PBT) framework,
+integrating nicely with `Test.@testset`. Under the hood it's similar
+to the Python fuzzing framework Hypothesis.
+
+The package features:
+
+ * Generation of (almost) arbitrary instances of types
+ * Minimization of failure cases
+ * Testing of statemachines
+ * Deterministic replaying of failures cases
+
+..and a bunch more! Please check out [the documentation](https://seelengrab.github.io/Supposition.jl/stable/) for more information.
+"""
 module Supposition
 
 export assume!, target!, reject, example