README.md in hypershield-0.1.0 vs README.md in hypershield-0.1.1
- old
+ new
@@ -2,20 +2,24 @@
:zap: Shield sensitive data in Postgres and MySQL
Great for business intelligence tools like [Blazer](https://github.com/ankane/blazer)
+[![Build Status](https://travis-ci.org/ankane/hypershield.svg?branch=master)](https://travis-ci.org/ankane/hypershield)
+
## How It Works
-Hypershield creates *shielded views* (in the `hypershield` schema by default) that hide sensitive tables and columns. By default, it hides columns with:
+Hypershield creates *shielded views* (in the `hypershield` schema by default) that hide sensitive tables and columns. The advantage of this approach over column-level privileges is you can use `SELECT *`.
+By default, it hides columns with:
+
- `encrypted`
- `password`
- `token`
- `secret`
-Give database users access to these views instead of the original tables. You can set the `search_path` so queries don’t need to be schema-qualified. The advantage of this approach over column-level privileges is you can use `SELECT *`.
+Give database users access to these views instead of the original tables.
## Database Setup
### Postgres
@@ -96,9 +100,15 @@
hypershield: {
hide: %w(encrypted password token secret),
show: %w(ahoy_visits.visit_token)
}
}
+```
+
+Log Hypershield SQL statements [master]
+
+```ruby
+Hypershield.log_sql = true
```
## TODO
- Create CLI