README.md in logstop-0.2.8 vs README.md in logstop-0.3.0
- old
+ new
@@ -1,8 +1,8 @@
# Logstop
-:fire: Keep personally identifiable information (PII) out of your logs
+:fire: Keep personal data out of your logs
```ruby
logger.info "Hi test@example.org!"
# => Hi [FILTERED]!
```
@@ -28,11 +28,11 @@
## Installation
Add this line to your application’s Gemfile:
```ruby
-gem 'logstop'
+gem "logstop"
```
And add it to your logger:
```ruby
@@ -51,9 +51,15 @@
To scrub IP addresses (IPv4), use:
```ruby
Logstop.guard(logger, ip: true)
+```
+
+To scrub MAC addresses, use: [unreleased]
+
+```ruby
+Logstop.guard(logger, mac: true)
```
Add custom rules with:
```ruby