diff --git a/README.md b/README.md index 8925c69..63b186e 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,29 @@ cp config-example.edn config.edn ``` sh java -jar isahn-[version]-standalone.jar ``` - -## Check format + +## Development + +### Check format ``` sh lein cljfmt check ``` -## Check format +### Linter ``` sh -lein cljfmt check +clj-kondo --lint src ``` - -## Linter + +### Check idiomatic ``` sh lein auto kibit ``` + +### Generate doc + +``` sh +lein codox +``` diff --git a/doc b/doc new file mode 120000 index 0000000..43cffdf --- /dev/null +++ b/doc @@ -0,0 +1 @@ +target/default/doc \ No newline at end of file diff --git a/doc/intro.md b/doc/intro.md deleted file mode 100644 index 2ca5d56..0000000 --- a/doc/intro.md +++ /dev/null @@ -1,3 +0,0 @@ -# Introduction to isahn - -TODO: write [great documentation](http://jacobian.org/writing/what-to-write/) diff --git a/project.clj b/project.clj index 592e47a..50e04a6 100644 --- a/project.clj +++ b/project.clj @@ -1,23 +1,28 @@ -(defproject isahn "0.1.0-SNAPSHOT" +(defproject isahn "1.0.0" :description "ISAHN check news stories for Hacker News" :url "http://example.com/FIXME" :micense {:name "EPL-2.0 OR GPL-2.0-or-later WITH Classpath-exception-2.0" - :url "https://www.eclipse.org/legal/epl-2.0/"} + :url "https://github.com/tanrax/important-stories-alert-for-hacker-news"} :dependencies [ - ; Clojure + ;; Clojure [org.clojure/clojure "1.10.0"] - ; Get config from .env + ;; Get config from .env [yogthos/config "1.1.4"] - ; Client HTTP + ;; Client HTTP [clj-http "3.10.0"] - ; Parse JSON + ;; Parse JSON [cheshire "5.8.1"] - ] + ] :plugins [ - ; Dev Tools + ;; Dev Tools + ;;; Watch changes [lein-auto "0.1.3"] + ;;; Check idiomatic bug [lein-kibit "0.1.7"] + ;;; Check format [lein-cljfmt "0.6.4"] + ;;; Generate documentation + [lein-codox "0.10.7"] ] :main ^:skip-aot isahn.core :target-path "target/%s"