Skip to content

Commit 40ed52a

Browse files
committed
Add additional info in README.md
1 parent dd40a6f commit 40ed52a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ PickleDB
55
[![Crate](https://img.shields.io/crates/v/pickledb.svg)](https://crates.io/crates/pickledb)
66
[![API](https://docs.rs/pickledb/badge.svg)](https://docs.rs/pickledb)
77

8-
PickleDB-rs is a lightweight and simple key-value store written in Rust, heavily inspired by [Python's PickleDB](https://pythonhosted.org/pickleDB/)
8+
PickleDB is a lightweight and simple key-value store written in Rust, heavily inspired by [Python's PickleDB](https://pythonhosted.org/pickleDB/)
99

1010
## PickleDB is fun and easy to use
1111

@@ -38,9 +38,18 @@ Add this to your `Cargo.toml`:
3838

3939
```toml
4040
[dependencies]
41-
pickledb-rs = "*"
41+
pickledb = "*"
4242
```
4343

4444
## Documentation
4545

46-
All documentation for this crate can be found in [docs.rs](https://docs.rs/pickledb)
46+
All documentation for this crate can be found in [docs.rs](https://docs.rs/pickledb)
47+
48+
## Examples
49+
50+
There are currently two examples shipped with PickleDB:
51+
52+
* [Hello World](https://github.com/seladb/pickledb-rs/tree/master/examples/hello_world) which shows the basic usage of PickleDB:
53+
create a new DB, load a DB from file, get/set key-value pairs of different types, and more
54+
* [Lists](https://github.com/seladb/pickledb-rs/tree/master/examples/lists) which shows how to use lists in PickleDB:
55+
create new lists, add/remove items from lists, retrieve items from lists, remove lists, and more

0 commit comments

Comments
 (0)