Skip to content

Commit

Permalink
readme: add description of the _VERSION
Browse files Browse the repository at this point in the history
  • Loading branch information
LeonidVas committed Mar 13, 2023
1 parent 094cbf9 commit b17096c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ align="right">
* [Installing](#installing)
* [Using the queue module](#using-the-queue-module)
* [Initialization](#initialization)
* [Get the module version](#get-the-module-version)
* [Creating a new queue](#creating-a-new-queue)
* [Set queue settings](#set-queue-settings)
* [Session identify](#session-identify)
Expand Down Expand Up @@ -425,6 +426,13 @@ cause an inconsistent state of the queue. As for the core drivers that use
background fibers (fifottl, limfifottl, utubettl) - they check the instance mode
on each iteration and will wait until the instance will be switched to rw mode.

## Get the module version
```lua
queue._VERSION
```

Returns the current version of the module.

## Creating a new queue

```lua
Expand Down

0 comments on commit b17096c

Please sign in to comment.