Skip to content

Commit dad9dcb

Browse files
committed
Update README
- Fixed a number of typos - Added syntax highlighting for snippets with code - Fixed incorrect option name for memcached protocol. README described `proto`, but in file `memcached/init.lua` used name `protocol` Fixes #77
1 parent 9649f2c commit dad9dcb

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
# memcached
99

10-
Memcached protocol 'wrapper' for tarantool.
10+
Memcached protocol 'wrapper' for Tarantool.
1111

1212
## Getting started
1313

@@ -38,7 +38,7 @@ packages available from our binary repository at http://tarantool.org/dist/maste
3838
system package `libsasl2-dev`):
3939

4040
``` bash
41-
luarocks install https://raw.githubusercontent.com/tarantool/memcached/master/memcached-scm-1.rockspec --local
41+
luarocks install https://raw.githubusercontent.com/tarantool/memcached/master/rockspecs/memcached-scm-1.rockspec --local
4242
```
4343

4444
### Usage
@@ -53,14 +53,14 @@ Now you're set up and ready to go!
5353

5454
### How to connect
5555

56-
Install tarantool package from repository ([described here](http://tarantool.org/download.html)).
56+
Install Tarantool package from repository ([described here](https://www.tarantool.io/download/)).
5757

5858
Paste the previous example to `/etc/tarantool/instances.enabled/memcached.lua` and start it with
5959
`tarantoolctl start memcached`.
6060

6161
Then try the following example:
6262

63-
``` session
63+
``` bash
6464
$ printf "set key 0 60 5\r\nvalue\r\n" | nc localhost 11211
6565
STORED
6666
$ printf "get key\r\n" | nc localhost 11211
@@ -79,7 +79,7 @@ END
7979

8080
## API
8181

82-
* `local memcached = require('memcached')` - acquire a library andle
82+
* `local memcached = require('memcached')` - acquire a library handle
8383
* `local instance = memcached.create(<name>, <uri>, <opts>)` - create a new instance, register it and run
8484
- `name` - a string with instance name
8585
- `uri` - a string with uri to bind to, for example: `0.0.0.0:11211` (only TCP is supported now)
@@ -98,7 +98,7 @@ END
9898
* *expire_full_scan_time* - time required for a full index scan (in seconds). defaiult is 3600
9999
* *verbosity* - verbosity of memcached logging. default is 0.
100100
* ~~*flush_enabled* - flush command availability. default is true~~
101-
* *proto* - the protocol, one of `negotiation`, `binary` or `text`).
101+
* *protocol* - the protocol, one of `negotiation`, `binary` or `text`.
102102
- `negotiation` - detect the protocol automatically at handshake (the default)
103103
- `binary` - binary memcached protocol
104104
- `text` - text memcached protocol
@@ -111,7 +111,7 @@ END
111111

112112
## SASL support
113113

114-
Usual rules for memcached are aplicable for this plugin:
114+
Usual rules for memcached are applicable for this plugin:
115115

116116
1. Create user (NOTE: it'll use custom folder):
117117

@@ -134,9 +134,9 @@ Usual rules for memcached are aplicable for this plugin:
134134

135135
NOTE: This will set custom path for database path
136136

137-
3. Run tarantool with memcached plugin with SASL enabled
137+
3. Run Tarantool with memcached plugin with SASL enabled
138138

139-
```
139+
```lua
140140
local memcached = require('memcached')
141141
local instance = memcached.create('my_instance', '0.0.0.0:11211', {
142142
sasl = true

0 commit comments

Comments
 (0)