From 7fa1172d18d4c5a553d0aeeda336a8fc36a74df2 Mon Sep 17 00:00:00 2001
From: voleger <dev.vegera@gmail.com>
Date: Sat, 10 Mar 2018 22:59:42 +0200
Subject: [PATCH] Add readme file

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1fb3dd7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# Queue Order
+
+## Introduction
+
+This is the module that provide functionality of sorting
+queue workers definitions. That causes an effect on queue execution order
+during cron run.
+
+## API
+
+No API.
+
+## Config
+
+All weight values of queue workers stored in `order` property
+of `queue_order.settings` config object. It contains key - value array,
+where key is the id of queue worker, value - the weight value.
+  
+```yaml
+# Example of `queue_order.settings` config object:
+order:
+  queue_worker_1: 0
+  queue_worker_2: -1
+  queue_worker_3: 1
+  queue_worker_4: 2
+``` 
+## UI
+
+This module provide functionality without any admin UI.
+It should be useful on production.
+Use [Queue Order UI](https://www.drupal.org/project/queue_order_ui)
+for development process.  
-- 
GitLab