Skip to content

Commit bcad516

Browse files
Update README.md
1 parent f062f7d commit bcad516

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,26 @@
77
# simple-redis-cache
88
Redis cache ready to scale with node-pool support
99

10+
> Cache Early; Cache Often
11+
1012
> Note: This lib is in beta
1113
1214
## Prerequisites
1315

1416
This module requires nodejs v4 or above as it has dependencies on constious es6 components such as Map, Set, Promise etc.
1517

18+
## Featuring
19+
- Out of the box default configuration (but fully configurable)
20+
- Provides both sync and async API
21+
- Scalable easily, less friction during locking and purging
22+
- Synchronized locking with a semaphore
23+
- Design for multithread environment
24+
- Extensible Logging
25+
- Serialization: Used to serialize values in distributed scenarios, can be configured.
26+
- Flexible Expiration: Through configuration, you can set a default expiration mode and time for each layer.
27+
- Statistics / Counters: Gather statistical information and track caching operations in Performance Monitor as needed.
28+
- Modular Design: Lib comes in many different packages, separating the features and dependencies.
29+
1630
### Getting started
1731

1832
npm install simple-redis-cache
@@ -26,3 +40,8 @@ This module requires nodejs v4 or above as it has dependencies on constious es6
2640
### Run tests
2741

2842
bash test.sh
43+
44+
45+
### Contributing
46+
47+
Feel free to make changes. Please see the [Contributors' Guide](https://github.com/pasupulaphani/simple-redis-cache/blob/master/CONTRIBUTING.md) for more information on contributing to the documentation.

0 commit comments

Comments
 (0)