Skip to content

Commit a12167f

Browse files
committed
Add Codox API documentation
1 parent ec47e74 commit a12167f

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ pom.xml.asc
1212
.hgignore
1313
.hg/
1414
/.clj-kondo
15+
/codox

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Or to your Leiningen project file:
1616

1717
[org.ring-clojure/ring-websocket-middleware "0.1.0-SNAPSHOT"]
1818

19-
## Usage
19+
## Documentation
2020

21-
TODO
21+
- [API Docs](http://ring-clojure.github.io/ring-websocket-middleware)
2222

2323
## License
2424

project.clj

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@
44
:license {:name "The MIT License"
55
:url "http://opensource.org/licenses/MIT"}
66
:dependencies [[org.clojure/clojure "1.9.0"]
7-
[ring/ring-core "1.12.1"]])
7+
[ring/ring-core "1.12.1"]]
8+
:plugins [[lein-codox "0.10.8"]]
9+
:codox {:output-path "codox"
10+
:source-uri "http://github.com/ring-clojure/ring-websocket-middleware/blob/{version}/{filepath}#L{line}"})

0 commit comments

Comments
 (0)