Merge pull request #7 from adamjosefus/development

Update Readme

Author: adamjosefus

Diff for: README.md

@@ -5,44 +5,85 @@ Simple caching solution in Typescript.
 
 ## `Cache<ValueType>`
 
+### Load or Generate
+
 ```ts
 const cache = new Cache<string>();
 
-const cacheKey = 'abc123';
+// Load from cache.
+// If not found, value will be generated and stored in cache.
+cache.load('key_1', () => {
+    // Some expensive operation
+    return 'Lorem ipsum';
+}); // Return type is string
 
-/**
- * Load from cache.
- * If not found, value will be generated and stored in cache.
- */
-cache.load(cacheKey, () => {
-    const result = 'Lorem ipsum';
+cache.has('key_1'); // true
+cache.load('key_1'); // 'Lorem ipsum'
 
-    // Some expensive operation
-    // ...
 
-    return result
-}); // -> string
+// Load from cache without generating.
+cache.load('key_2'); // Return type is string | undefined
+
+// Save to cache.
+cache.save('key_2', 'Lorem ipsum');
+
+// Check if cache exists.
+cache.has('key_2'); // true
+cache.load('key_2'); // 'Lorem ipsum'
+```
+
+
+###  Invalidation
+#### Expiration
+```ts
+const cache = new Cache<number>();
 
+cache.save('key', 42, {
+    expire: 1000 // Expire after 1 second.
+});
 
-/**
- * Load from cache.
- */
-cache.load(cacheKey); // -> string | undefined
 
+// Works with load generator too.
+cache.load('key', () => 42, { expire: 1000 });
+```
 
-/**
- * Save to cache.
- */
-cache.save(cacheKey, 'Lorem ipsum');
+```ts
+const cache = new Cache<number>();
 
+cache.save('key', 42, {
+    expire: 1000,
+    sliding: true // Update expiration after each load
+});
+```
 
-/**
- * Check if cache exists.
- */
-cache.has(cacheKey); // -> boolean
+#### Files
+```ts
+const cache = new Cache<string>();
 
+cache.save('key', "My text data", {
+    files: [
+        'file_1.txt',
+        'file_2.txt'
+    ] // Expired when some file is modified or deleted.
+});
 ```
 
+#### Callbacks
+```ts
+const cache = new Cache<string>();
+
+function isValid(): boolean {
+    //...
+    return true;
+}
+
+cache.save('key', "My text data", {
+    callbacks: [
+        isValid,
+        () => false,
+    ] // Expired when some callback return false.
+});
+```
 
 
 ## Documentation 📖