Skip to content

Commit b463532

Browse files
committed
update README.md
1 parent 5e6645a commit b463532

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ After which it provides all the features of cache seamlessly.<br>
3434

3535
The features provided by the library are,
3636
* Easy Implementation<br>
37-
To implement the cache the user has to implement only two interfaces (i.e [CacheDB]() and [PersistentDB]()).
37+
To implement the cache the user has to implement only two interfaces (i.e <b>CacheDB</b> and <b>PersistentDB</b>).
3838
These databases can be of any type.(Relational or Non-Relational database) and rest is taken care by the SimplCache.
3939
* Least Recently Used (LRU) Eviction<br>
4040
Least recently used cache object is evicted when cache reaches maximum limit.
@@ -72,7 +72,7 @@ dependencies {
7272
<td><b>IMPORTANT</b></td>
7373
<td>To set the cache size in terms of object memory VM options have to be enabled while executing the main class of your project.<br>
7474
<ul>
75-
<li>Download the <a href="">JAR</a><br></li>
75+
<li>Download the <a href="https://mvnrepository.com/artifact/com.github.lekhana3003/SimplCache">JAR</a><br></li>
7676
<li>Execute java function by enabling VM options as: java -javaagent:"path to downloaded jar"<br>
7777
Ex:java -javaagent:"../SimplCache.jar"</li>
7878
</ul>
@@ -89,7 +89,7 @@ For Reference:<br>
8989

9090
### 3.1 Getting Started
9191
To implement cache using the library, it requires some methods to be implemented which are present in the interfaces
92-
[CacheDB]() and [PersistentDB](). The SimplCache object is built using the SimplCache Builder.
92+
<b>CacheDB</b> and <b>PersistentDB</b>. The SimplCache object is built using the SimplCache Builder.
9393
The Constructor of the builder takes two objects of CacheDB and PersistentDB.The model of the object that has to be stored in the cache has to be provided while implementing the interfaces.<br>
9494
Example:<br>
9595
The object to be stored in the cache is Car Model.<br>
@@ -244,7 +244,7 @@ This parameter given by the user decides if the modified objects should be writt
244244

245245
##### Saving:
246246
This method is used to save the state of cache at any given time. This method returns a string which is encrypted with default encryption algorithm.
247-
If the user wants to implement any other encryption mechanism, the user is required to pass an object of class which has implemented [SimplCacheEncryptor](). The cache objects are written back into persistent database before saving the state,
247+
If the user wants to implement any other encryption mechanism, the user is required to pass an object of class which has implemented <b>SimplCacheEncryptor</b>. The cache objects are written back into persistent database before saving the state,
248248
This method returns only the keys of cache object and also stores the properties which are set for the cache in the SimplCache object. It does not store the entire object which is stored in the cache.
249249
The two variations as follows,<br>
250250
* With default encryptor,
@@ -265,7 +265,7 @@ The two variations as follows,<br>
265265
##### Building from save state:
266266
This method is used to build back the cache from the string which is returned by the <b>saveState()</b> method.
267267
This method restores cache objects from persistent database.
268-
This method takes cacheDB and persistenseDB implemented objects again along with optional [SimplCacheEncryptor]() object.
268+
This method takes cacheDB and persistenseDB implemented objects again along with optional <b>SimplCacheEncryptor</b> object.
269269
* With default encryptor,
270270
```java
271271
SimplCache<Car> simplCache1=SimplCache.buildFromSaveState(state,cacheDB,persistentDB);
@@ -282,10 +282,10 @@ The default encryptor does not guarantee any security.
282282
---
283283

284284
## 4. Example
285-
[Spring Boot implemenation of SimplCache Library]()
285+
[Spring Boot implemenation of SimplCache Library](https://github.com/lekhana3003/SimplCacheSpringDemo)
286286

287287
## 5. License
288-
[Apache 2.0 License for SimplCache]()
288+
289289
```
290290
Copyright 2020 Lekhana Ganji
291291

0 commit comments

Comments
 (0)