Create an empty documentation docc

orlandos-nl · Oct 21, 2023 · eaf7c50 · eaf7c50
1 parent a4b7f3e
commit eaf7c50
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/Documentation.docc/Documentation.md b/Documentation.docc/Documentation.md
@@ -0,0 +1,16 @@
+# ``MongoQueue``
+
+A MongoDB-based Job Queue API for Swift applications.
+
+## Overview
+
+This library provides a framework for storing and processing a queue of jobs in MongoDB. It uses [MongoKitten](https://github.com/orlandos-nl/MongoKitten) as a driver, using a `MonogKitten.MongoCollection` of your choosing for storing these jobs.
+
+## Topics
+
+- ``MongoQueue``
+
+### Job Types
+
+- ``ScheduledTask``
+- ``RecurringTask``