Write README

README.md

@@ -1,25 +1,34 @@
 # log4j2-plugins-cache
 
-A Leiningen plugin to do many wonderful things.
+This plugin fixes conflicting Log4j2PluginCache.dat files when building an uberjar using leiningen.
 
-## Usage
+See [https://issues.apache.org/jira/browse/LOG4J2-673](LOG4J2-673) for reference.
 
-FIXME: Use this for user-level plugins:
+You might see error messages such as below if you depend on any Log4j2 plugins in your project.
 
-Put `[log4j2-plugins-cache "0.1.0-SNAPSHOT"]` into the `:plugins` vector of your `:user`
-profile.
+```text
+ERROR StatusLogger Unrecognized format specifier [d]
+ERROR StatusLogger Unrecognized conversion specifier [d] starting at position 16 in conversion pattern.
+ERROR StatusLogger Unrecognized format specifier [thread]
+ERROR StatusLogger Unrecognized conversion specifier [thread] starting at position 25 in conversion pattern.
+ERROR StatusLogger Unrecognized format specifier [level]
+ERROR StatusLogger Reconfiguration failed: No configuration found for '2b43529a' at 'null' in 'null'
+```
 
-FIXME: Use this for project-level plugins:
+## Usage
 
-Put `[log4j2-plugins-cache "0.1.0-SNAPSHOT"]` into the `:plugins` vector of your project.clj.
+Add the following to your project.clj to laod the plugin.
 
-FIXME: and add an example usage that actually makes sense:
+```clj
+  :plugins
+  [[arctype/log4j2-plugins-cache "0.1.0-SNAPSHOT"]]
 
-    $ lein log4j2-plugins-cache
+  :middleware [leiningen.log4j2-plugins-cache/middleware]
+```
 
 ## License
 
-Copyright © 2018 FIXME
+Copyright © 2018 Arctype Corporation.
 
 Distributed under the Eclipse Public License either version 1.0 or (at
 your option) any later version.