Adds examples to .dir-locals.el section in README

CF #387.

I think this might show that it would be nice to have a more-convenient way to override various pieces of functionality, if possible. That would make customizing Projectile's behavior easier.
You could also have overridden the default compile command for the project type you're dealing with.