chore: update README

Author: thomasconner

README.md

@@ -5,12 +5,12 @@
 JavaScript library that can be used in a web browser or Node.js application to gather information using https://ipdata.co.
 
 **Table of Contents**
+
 - [Install](#install)
 - [Import the library](#import-the-library)
 - [Use](#use)
-  * [Lookup](#lookup)
-  * [Lookup Bulk](#lookup-bulk)
-
+  - [Lookup](#lookup)
+  - [Lookup Bulk](#lookup-bulk)
 
 ## Install
 
@@ -32,76 +32,83 @@ Create an instance of the `IPData` class and pass your api key for IPData as the
 const ipdata = new IPData('<apiKey>');
 ```
 
-The library will cache responses using the `lookup()` method for 24 hours using a LRU cache. You can turn off the cache by passing `false` as the second parameter to the constructor.
+The library will cache 4096 ip addresses responses for 24 hours using a LRU cache by default. You can configure the cache by passing an object as the second paramenter.
+
+```js
+const cacheConfig = {
+  max: 1000, // max size
+  maxAge: 10 * 60 * 1000, // max age in ms (i.e. 10 minutes)
+};
+const ipdata = new IPData('<apiKey>', cacheConfig);
+```
+
+**Note:** To disable the cache pass `-1` as the `maxAge`.
 
 ```js
-const ipdata = new IPData('<apiKey>', false);
+const cacheConfig = {
+  maxAge: -1, // disable the cache
+};
+const ipdata = new IPData('<apiKey>', cacheConfig);
 ```
 
 ### Lookup
 
 The library will lookup the ip address of the host computer if no ip address is provided.
 
 ```js
-ipdata.lookup()
-  .then(function(info) {
-    // info.ip === '<hostcomputerip>'
-    // ...
-  });
+ipdata.lookup().then(function(info) {
+  // info.ip === '<hostcomputerip>'
+  // ...
+});
 ```
 
 You can pass an ip address as the first parameter to the `lookup()` method to lookup information about the ip address using IPData.
 
 ```js
-ipdata.lookup('1.1.1.1')
-  .then(function(info) {
-    // info.ip === 1.1.1.1
-    // ...
-  });
+ipdata.lookup('1.1.1.1').then(function(info) {
+  // info.ip === 1.1.1.1
+  // ...
+});
 ```
 
 You can specify only a select field to be returned when looking up an ip address by passing a field as the second parameter to the `lookup()` method.
 
 ```js
 const ip = '1.1.1.1';
-const selectField = 'ip'
-ipdata.lookup(ip, selectField)
-  .then(function(info) {
-    // info.select_field === 1.1.1.1
-    // ...
-  });
+const selectField = 'ip';
+ipdata.lookup(ip, selectField).then(function(info) {
+  // info.select_field === 1.1.1.1
+  // ...
+});
 ```
 
 You can specify only certain fields to be returned when looking up an ip address by passing an array of fields as the third parameter to the `lookup()` method.
 
 ```js
 const ip = '1.1.1.1';
 const fields = ['ip', 'city'];
-ipdata.lookup(ip, null, fields)
-  .then(function(info) {
-    // ...
-  });
+ipdata.lookup(ip, null, fields).then(function(info) {
+  // ...
+});
 ```
 
 ### Bulk Lookup
 
 You can lookup multiple ip addresses with one API call using the `bulkLookup()` method.
 
 ```js
-ipdata.bulkLookup(['1.1.1.1', '1.0.0.1'])
-  .then(function(info) {
-    // info.responses[0].ip === 1.1.1.1
-    // ...
-  });
+ipdata.bulkLookup(['1.1.1.1', '1.0.0.1']).then(function(info) {
+  // info.responses[0].ip === 1.1.1.1
+  // ...
+});
 ```
 
 You can specify only certain fields to be returned when looking up multiple ip addresses by passing an array of fields as the second parameter to the `bulkLookup()` method.
 
 ```js
 const ips = ['1.1.1.1', '1.0.0.1'];
 const fields = ['ip', 'city'];
-ipdata.bulkLookup(ips, fields)
-  .then(function(info) {
-    // ...
-  });
+ipdata.bulkLookup(ips, fields).then(function(info) {
+  // ...
+});
 ```