docs: Update README and documents for licenses

liquidz · Oct 23, 2023 · 359e78f · 359e78f
1 parent 0631af6
commit 359e78f
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/README.adoc b/README.adoc
@@ -160,6 +160,13 @@ When specified functions contain some invalid strings, `execute` function will f
 |
 | You can add `description` tag to pom.xml.
 
+| licenses
+| `sequential?`
+|
+|
+| You can add `licenses` tag to pom.xml.
+See link:./doc/format/licenses.adoc[doc/format/licenses.adoc] for more details.
+
 | source-dirs
 | `sequential?`/`set?` of string
 |

diff --git a/doc/format/licenses.adoc b/doc/format/licenses.adoc
@@ -0,0 +1,30 @@
+= licenses
+
+`:licenses` key in `build.edn` file shoud be a sequence of the following map.
+
+[cols="1,1,1,6a"]
+|===
+| name | type | required? | description
+
+| name
+| `string?`
+| Yes
+| License name
+
+| url
+| `string?`
+| Yes
+| License URL
+
+|===
+
+== Example
+
+[source,clojure]
+----
+{:lib foo/bar
+ :version "0.1.0"
+ :description "Your great library"
+ :licenses [{:name "Eclipse Public License - v 2.0"
+             :url "https://www.eclipse.org/legal/epl-2.0/"}]}
+----