From 398b308d17c9f6073cad3cb63fc5b4eafef72000 Mon Sep 17 00:00:00 2001
From: liquidz <liquidz.uo@gmail.com>
Date: Sat, 19 Nov 2022 10:11:11 +0900
Subject: [PATCH] docs: Add document for :antq/exclude

cf. #190
---
 README.adoc         |  4 ++++
 doc/exclusions.adoc | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+)
 create mode 100644 doc/exclusions.adoc

diff --git a/README.adoc b/README.adoc
index 875f3f8b..719ead18 100644
--- a/README.adoc
+++ b/README.adoc
@@ -187,6 +187,9 @@ E.g.
 
 When you specified a version number, antq will report the latest version excluding only the specified version.
 
+You could also specify dependencies to exclude with `:antq/exclude` metadata.
+See link:./doc/exclusions.adoc[Exclusions] for more information.
+
 NOTE: You must specify `groupId/artifactId` for Java dependencies.
 
 === --directory=DIRECTORY
@@ -319,6 +322,7 @@ Skip checking diff between deps' versions. Disabled by default.
 * link:./doc/gradle.adoc[Work with Gradle]
 * link:./doc/proxy.adoc[Run behind proxy]
 * link:./doc/timeout.adoc[Timeouts]
+* link:./doc/exclusions.adoc[Exclusions]
 
 == License
 
diff --git a/doc/exclusions.adoc b/doc/exclusions.adoc
new file mode 100644
index 00000000..328a8eb3
--- /dev/null
+++ b/doc/exclusions.adoc
@@ -0,0 +1,45 @@
+= Exclusions
+
+When you'd like to exclude specific dependencies, you could `--exclude` option as you know.
+
+Otherwise, the following ways are available.
+
+== Metadata in your project file
+
+`:antq/exclude` metadata is available for excluding dependencies.
+
+=== deps.edn
+[source,clojure]
+----
+{:deps {foo/bar ^:antq/exclude {:mvn/version "..."}}}
+----
+
+=== shadow-cljs.edn
+
+[source,clojure]
+----
+{:dependencies [^:antq/exclude [foo/bar "..."]]}
+----
+
+=== project.clj
+
+[source,clojure]
+----
+(defproject foo "0.1.0-SNAPSHOT"
+  :dependencies [^:antq/exclude [foo/bar "..."]]
+----
+
+=== build.boot
+
+[source,clojure]
+----
+(set-env!
+  :dependencies '[^:antq/exclude [foo/bar "..."]])
+----
+
+=== bb.edn
+
+[source,clojure]
+----
+{:deps {foo/bar ^:antq/exclude {:mvn/version "..."}}}
+----