Update Readme

This commit is contained in:
Andros Fenollosa 2019-08-05 10:32:59 +02:00
parent a7ffaf6cd8
commit 481e0d8b35
2 changed files with 32 additions and 1 deletions

11
Makefile Normal file
View File

@ -0,0 +1,11 @@
.DEFAULT_GOAL := build
build:
make check
lein codox
lein uberjar
check:
lein cljfmt check
clj-kondo --lint src
lein kibit

View File

@ -1,5 +1,11 @@
# isahn
Important stories alert for Hacker News.
[Telegram channel](https://leiningen.org/)
The entire code in this repository is in charge of feeding the Telegram channel. Every hour check for a new story with more than 600 points in Hacker News.
## Installation
``` sh
@ -9,7 +15,15 @@ cp config-example.edn config.edn
## Usage
``` sh
java -jar isahn-[version]-standalone.jar
java -jar target/uberjar/isahn-[version]-standalone.jar
```
## Build
Install [Leingengen](https://leiningen.org/) and then...
``` sh
make
```
## Development
@ -37,3 +51,9 @@ lein auto kibit
``` sh
lein codox
```
### All
``` sh
make check
```