You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19Lines changed: 19 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,26 @@
7
7
# simple-redis-cache
8
8
Redis cache ready to scale with node-pool support
9
9
10
+
> Cache Early; Cache Often
11
+
10
12
> Note: This lib is in beta
11
13
12
14
## Prerequisites
13
15
14
16
This module requires nodejs v4 or above as it has dependencies on constious es6 components such as Map, Set, Promise etc.
15
17
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
+
16
30
### Getting started
17
31
18
32
npm install simple-redis-cache
@@ -26,3 +40,8 @@ This module requires nodejs v4 or above as it has dependencies on constious es6
26
40
### Run tests
27
41
28
42
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