Skip to content

Commit 3f2db88

Browse files
readme: describe package info API
Add `_VERSION` handle description to the README. Follows #342
1 parent ac6a250 commit 3f2db88

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ It also provides the `crud-storage` and `crud-router` roles for
1515

1616
- [Quickstart](#quickstart)
1717
- [API](#api)
18+
- [Package info](#package-info)
1819
- [Insert](#insert)
1920
- [Insert many](#insert-many)
2021
- [Get](#get)
@@ -190,6 +191,19 @@ Current limitations for using custom sharding key:
190191
- `primary_index_fieldno_map` is not cached, see
191192
[#243](https://github.com/tarantool/crud/issues/243).
192193

194+
### Package info
195+
196+
```lua
197+
tarantool> require('crud')._VERSION
198+
---
199+
- 1.1.0
200+
...
201+
```
202+
203+
Use `_VERSION` handle to check installed module version.
204+
The handle was introduced in `1.1.0`. If installed from master,
205+
`_VERSION` shows last tagged version.
206+
193207
### Insert
194208

195209
```lua

0 commit comments

Comments
 (0)