Skip to content

Commit 61fcb63

Browse files
committed
Update Readme on local development and debugging
1 parent d5504cb commit 61fcb63

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,29 @@ config.kredis.connector = ->(config) { SomeRedisProxy.new(config) }
259259

260260
By default Kredis will use `Redis.new(config)`.
261261

262+
## Development
263+
264+
A development console is available by running `bin/console`.
265+
266+
From there, you can experiment with Kredis. e.g.
267+
268+
```rb
269+
>> str = Kredis.string "mystring"
270+
Kredis (0.1ms) Connected to shared
271+
=>
272+
#<Kredis::Types::Scalar:0x0000000134c7d938
273+
...
274+
>> str.value = "hello, world"
275+
Kredis Proxy (2.4ms) SET mystring ["hello, world"]
276+
=> "hello, world"
277+
>> str.value
278+
```
279+
280+
Run tests with `bin/test`.
281+
282+
[`debug`](https://github.com/ruby/debug) can be used in the development console and in the test suite by inserting a
283+
breakpoint, e.g. `debugger`.
284+
262285
## License
263286

264287
Kredis is released under the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)