Files
jlibredis/README.md
Jonathan Leibiusky eeeef3af68 Updated readme
2010-09-08 11:12:15 -03:00

78 lines
2.5 KiB
Markdown

# Jedis
Jedis is a blazingly small and sane redis java client.
Jedis was conceived to be EASY to use.
Jedis is fully compatible with redis 2.0.0.
## Why Jedis is a Release Candidate?
Because I want to add Sharding and add more documentation to the site. And also publish the benchmark results, which are pretty good (around 26 Kops for GETs and SETs, and 126 Kops for GETs and SETs in pipeling mode).
## What will be available soon?
- Sharding
- More and more code and performance improvements
But stay close because things are going fast and all this will be implemented soon!
## Ok.. so what can I do with Jedis?
All of the following reids features are supported:
- Sorting
- Connection handling
- Commands operating on all the kind of values
- Commands operating on string values
- Commands operating on hashes
- Commands operating on lists
- Commands operating on sets
- Commands operating on sorted sets
- Transactions
- Pipelining
- Publish/Subscribe
- Persistence control commands
- Remote server control commands
- Connection pooling
## How do I use it?
You can download the latests build at:
http://github.com/xetorthio/jedis/downloads
To use it just:
Jedis jedis = new Jedis("localhost");
jedis.connect();
jedis.set("foo", "bar");
String value = jedis.get("foo");
For more usage examples check the tests. Soon I will add a nice wiki with everything you should know.
And you are done!
License
-------
Copyright (c) 2010 Jonathan Leibiusky
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.