Documentation updated

README.md

@@ -6,15 +6,15 @@
 
 This is a library for PHP to anonymize IP addresses. This makes it easier to respect user privacy, and it makes it more
 difficult to identify an end user by his IP address. Anonymizing IP addresses can be useful for a lot of cases where the
-exact IP address is not important, for example in a statistical analysis.
+exact IP address is not important or even undesired, for example in a statistical analysis.
 
 This library supports both IPv4 and IPv6 addresses. Addresses are anonymized to their network ID.
 
 The default settings anonymize an IP address to a /24 subnet (IPv4) or a /64 subnet (IPv6), but these can be customized.
 
-For instance, the IP address `192.168.178.123` is anonymized by default to `192.168.178.0`.
+For instance, the IPv4 address `192.168.178.123` is anonymized by default to `192.168.178.0`.
 
-The IP address `192.168.178.123` is anonymized by default to `192.168.178.0`.
+The IPv6 address `2a03:2880:2110:df07:face:b00c::1` is anonymized by default to `2610:28:3090:3001::`.
 
 ## Example
 
@@ -45,6 +45,18 @@ var_dump($ipAnonymizer->anonymize('2a03:2880:2110:df07:face:b00c::1'));
 
 var_dump($ipAnonymizer->anonymize('2610:28:3090:3001:dead:beef:cafe:fed3'));
 // returns 2610:28:3090:3001::
+
+// Use a custom mask:
+$ipAnonymizer->ipv4NetMask = "255.255.0.0";
+var_dump($ipAnonymizer->anonymize('192.168.178.123'));
+// returns 192.168.0.0
+
+// You can use this class also in a static way:
+var_dump(IpAnonymizer::anonymizeIp('192.168.178.123'));
+// returns 192.168.178.0
+
+var_dump(IpAnonymizer::anonymizeIp('2610:28:3090:3001:dead:beef:cafe:fed3'));
+// returns 2610:28:3090:3001::
 ```
 
 ## License

example.php

@@ -26,6 +26,11 @@
 var_dump($ipAnonymizer->anonymize('2610:28:3090:3001:dead:beef:cafe:fed3'));
 // returns 2610:28:3090:3001::
 
+// Use a custom mask:
+$ipAnonymizer->ipv4NetMask = "255.255.0.0";
+var_dump($ipAnonymizer->anonymize('192.168.178.123'));
+// returns 192.168.0.0
+
 // You can use this class also in a static way:
 var_dump(IpAnonymizer::anonymizeIp('192.168.178.123'));
 // returns 192.168.178.0