update doc: development guide.
[![CircleCI](https://circleci.com/gh/laixintao/iredis.svg?style=svg)](https://circleci.com/gh/laixintao/iredis)
[![PyPI version](https://badge.fury.io/py/iredis.svg)](https://badge.fury.io/py/iredis)
-A Terminal Client for Redis with AutoCompletion and Syntax Highlighting.
+A Terminal Client for Redis with AutoCompletion and Syntax Highlighting. It is an alternative for redis-cli. IRedis is supposed to friendly for both user and redis-server, which means it is safe to use IRedis on production server. IRedis provide a `--strict` mode to prevent accidently running dangerous command, like `KEYS *`(See [here](https://redis.io/topics/latency), the *Latency generated by slow commands* section.
![](./docs/assets/auto-complete.png)
@@ -36,19 +36,43 @@ $ iredis -h
## Development
+### Setup Environment
+
+iredis favors [poetry](https://github.com/sdispater/poetry) as a packagement tool. You can setup a develop envioment on your computer easily.
+
+First, install poetry(You can do it in a python's virtualenv):
+
+```
+pip install poetry
+```
+
+Then run(which euqals `pip install -e .`):
+
+```
+poetry install --develop=DEVELOP
+```
+
+### Development Logs
+
+Since this is a commandline tool, so we didn't write logs to stdout.
+
+You can `tail -f iredis.log` to see logs, the log is pretty clear, you can see what actually happend from log files.
+
+### Command Reference
+
There is a full Redis command list in [commands.csv](commands.csv) file, downloaded by:
```
-python scripts/download_redis_commands.py > commands.csv
+python scripts/download_redis_commands.py > data/commands.csv
```
-`commands.csv` is here only for test if redis.io updated, do not package it into release.
+`commands.csv` is here only for test if redis.io was updated, do not package it into release.
Current implemented commands: [command_syntax.csv](command_syntax.csv).
## Planned Features
-- Full help document.
+Please see issue. And you are welcome to submit one.
## Related Projects
