From eaf7c5062b5db7c232020afabf00bddeab0dfaac Mon Sep 17 00:00:00 2001 From: Joannis Orlandos Date: Sun, 22 Oct 2023 01:36:35 +0200 Subject: [PATCH] Create an empty documentation docc --- Documentation.docc/Documentation.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 Documentation.docc/Documentation.md diff --git a/Documentation.docc/Documentation.md b/Documentation.docc/Documentation.md new file mode 100644 index 0000000..6c085e8 --- /dev/null +++ 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``