Skip to content

Commit

Permalink
Update README to mention custom settings
Browse files Browse the repository at this point in the history
  • Loading branch information
tnm committed Jan 18, 2014
1 parent f3b07df commit 76d44cc
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,11 @@ A **priority queue**
Using QR
-------------------------------------

QR contains a few small classes to represent each data structure. To get access to one of these fine data structures, just create a relevant instance.
QR contains a few small classes to represent each data structure. To get access to one of these fine data structures, just create a relevant instance. You can pass custom options for the underlying Redis instance as keyword arguments. For example:

```python
Queue('brand_new_queue_name', host='localhost', port=9000)
```

* A first-position **key** argument is required for all objects. It's the Redis **key** you want to be associated with the QCDS.
* A second-position **size** argument is required for **CappedCollection**. That's how big you want to let the collection get.
Expand Down

0 comments on commit 76d44cc

Please sign in to comment.