important-stories-alert-for.../README.md

40 lines
333 B
Markdown
Raw Normal View History

2019-07-29 20:02:33 +02:00
# isahn
## Installation
2019-08-04 11:00:35 +02:00
``` sh
2019-08-02 00:01:34 +02:00
cp config-example.edn config.edn
2019-08-04 11:00:35 +02:00
```
2019-07-29 20:02:33 +02:00
2019-08-02 00:01:34 +02:00
## Usage
2019-07-29 20:02:33 +02:00
2019-08-04 11:00:35 +02:00
``` sh
java -jar isahn-[version]-standalone.jar
```
2019-08-04 11:22:57 +02:00
## Development
### Check format
2019-08-04 11:00:35 +02:00
``` sh
lein cljfmt check
```
2019-08-04 11:22:57 +02:00
### Linter
2019-08-04 11:00:35 +02:00
``` sh
2019-08-04 11:22:57 +02:00
clj-kondo --lint src
2019-08-04 11:00:35 +02:00
```
2019-08-04 11:22:57 +02:00
### Check idiomatic
2019-08-04 11:00:35 +02:00
``` sh
lein auto kibit
```
2019-08-04 11:22:57 +02:00
### Generate doc
``` sh
lein codox
```