Add a doc on how to enable acyclic dependency checking in your project

1 files changed, 6 insertions, 1 deletions

diff --git a/README.md b/README.md
index 6492da0..45a8df5 100644
--- a/README.md
+++ b/README.md
@@ -41,6 +41,11 @@ There are two different ways to use `sbt-settings` configuration:
 
 Do `sbt reload` after adding a plugin and changing project configuration.
 
+### Acyclic import checking
+To enable global project-level acyclic dependency checking in your project you need to do two things:
+
+1. Add this to your `build.sbt` file in the global scope: `scalacOptions += "-P:acyclic:force"`
+2. Add this to your `.settings(...)` lines in your project definition in build.sbt: `.settings(acyclicSettings)`
 
 ## Reference
 
@@ -68,4 +73,4 @@ Scala version — 2.11.11, flags configured:
 
 ## Examples
 
-For examples please refer to [Driver Template](https://github.com/drivergroup/***REMOVED***), [Core library](https://github.com/drivergroup/***REMOVED***) or [***REMOVED***](https://github.com/drivergroup/***REMOVED***) projects.
\ No newline at end of file
+For examples please refer to [Driver Template](https://github.com/drivergroup/***REMOVED***), [Core library](https://github.com/drivergroup/***REMOVED***) or [***REMOVED***](https://github.com/drivergroup/***REMOVED***) projects.