Skip to content

Commit 3a54d91

Browse files
committed
Add more docs
1 parent 1aa91a7 commit 3a54d91

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,34 @@ dependencies {
2929
}
3030
```
3131

32+
### Usage
33+
34+
####Get Instance
35+
Get an instance of ObjectCache. Pass in a `cacheDir` (`File`) a `folderName` (`String`) along with the `appVersion`.
36+
37+
```
38+
ObjectCache.cacheInstance(cacheDir, folder, appVersion);
39+
40+
or
41+
42+
ObjectCache.defaultCache(cacheDir, appVersion);
43+
```
44+
45+
####Write
46+
```
47+
ObjectCache.cacheInstance(cacheDir, folder, appVersion).write(key, object, expiry);
48+
```
49+
50+
####Fetch
51+
Will return null, if the object has expired
52+
```
53+
ObjectCache.cacheInstance(cacheDir, folder, appVersion).fetch(key, Class.class);
54+
```
55+
56+
####Fetch Even if Expired
57+
```
58+
ObjectCache.cacheInstance(cacheDir, folder, appVersion).fetchEvenIfExpired(key, Class.class);
59+
```
60+
3261
## License
3362
ObjectCache is available under the MIT license. See the LICENSE file for more info.

0 commit comments

Comments
 (0)