Add Codox API documentation

ring-clojure · May 5, 2024 · a12167f · a12167f
1 parent ec47e74
commit a12167f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,4 @@ pom.xml.asc
 .hgignore
 .hg/
 /.clj-kondo
+/codox
diff --git a/README.md b/README.md
@@ -16,9 +16,9 @@ Or to your Leiningen project file:
 
     [org.ring-clojure/ring-websocket-middleware "0.1.0-SNAPSHOT"]
 
-## Usage
+## Documentation
 
-TODO
+- [API Docs](http://ring-clojure.github.io/ring-websocket-middleware)
 
 ## License
 

diff --git a/project.clj b/project.clj
@@ -4,4 +4,7 @@
   :license {:name "The MIT License"
             :url "http://opensource.org/licenses/MIT"}
   :dependencies [[org.clojure/clojure "1.9.0"]
-                 [ring/ring-core "1.12.1"]])
+                 [ring/ring-core "1.12.1"]]
+  :plugins [[lein-codox "0.10.8"]]
+  :codox {:output-path "codox"
+          :source-uri "http://github.com/ring-clojure/ring-websocket-middleware/blob/{version}/{filepath}#L{line}"})
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,3 +12,4 @@ pom.xml.asc @@
     .hgignore
     .hg/
     /.clj-kondo
+    /codox