Skip to content

Commit 7750c79

Browse files
committed
readme: add quickstart section
My wish is to let a user know how to experiment with crud API and what to do next.
1 parent 5291947 commit 7750c79

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ It also provides the `crud-storage` and `crud-router` roles for
1313
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1414
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1515

16+
- [Quickstart](#quickstart)
1617
- [API](#api)
1718
- [Insert](#insert)
1819
- [Get](#get)
@@ -37,6 +38,29 @@ It also provides the `crud-storage` and `crud-router` roles for
3738

3839
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3940

41+
## Quickstart
42+
43+
First, [install Tarantool](https://www.tarantool.io/en/download).
44+
45+
Now you have the following options how to learn crud API and use it in a
46+
project:
47+
48+
* Play with crud on a testing dataset on a single instance:
49+
50+
```shell
51+
$ git clone https://github.com/tarantool/crud.git
52+
$ cd crud
53+
$ tarantoolctl rocks make
54+
$ ./doc/playground.lua
55+
tarantool> crud.select('customers', {{'<=', 'age', 35}}, {first = 10})
56+
tarantool> crud.select('developers', nil, {first = 6})
57+
```
58+
* Add crud into dependencies of a Cartridge application and add crud roles into
59+
dependencies of your roles (see [Cartridge roles](#cartridge-roles) section).
60+
* Add crud into dependencies of your application (rockspec, RPM spec -- depends
61+
of your choice) and call crud initialization code from storage and router
62+
code (see [API](#api) section).
63+
4064
## API
4165

4266
The CRUD operations should be called from router.

0 commit comments

Comments
 (0)