From ba7085b28c1822315053e2fac40b6351a208fdca Mon Sep 17 00:00:00 2001 From: Grigory Romodanovskiy Date: Sat, 28 Apr 2018 20:02:33 -0400 Subject: [PATCH] readme updated, example config updated, project.clj updated --- README.md | 58 +++++++++++++++++++++++----------------------- example-config.edn | 8 ++++--- project.clj | 6 ++--- 3 files changed, 37 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 3e00eec..a705510 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,48 @@ -# org.red/killbot +# org.red/ares -TODO: Brief description +A tool that fetches information from [zKillboard] and posts relevant killmails to a discord channel via a webhook. +Example: ![alt text](https://i.imgur.com/LUbgL5U.png) +[zKillboard]: https://zkillboard.com ## Releases and Dependency Information -* Releases are published to TODO_LINK - -* Latest stable release is TODO_LINK - -* All released versions TODO_LINK - -[Leiningen] dependency information: - - [org.red/killbot "0.1.0-SNAPSHOT"] - -[Maven] dependency information: - - - org.red - killbot - 0.1.0-SNAPSHOT - - -[Leiningen]: http://leiningen.org/ -[Maven]: http://maven.apache.org/ - - +The project is intended to be used as an application, not a library, and therefore not published to clojars/maven. +The latest precompiled binaries can be found in releases tab on github. ## Usage -TODO - +Supply a config file via a cmd parameter `-c` (example: `-c example-config.edn`) ## Change Log -* Version 0.1.0-SNAPSHOT +* Version 0.3.0-SNAPSHOT - Support for multiple destinations, filtering based on region +* Version 0.1.0-SNAPSHOT - Initial release ## Copyright and License +MIT License + + +Copyright © 2018 greg2010 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: -Copyright © 2018 TODO_INSERT_NAME +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. -TODO: [Choose a license](http://choosealicense.com/) +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/example-config.edn b/example-config.edn index f547484..a84ee27 100644 --- a/example-config.edn +++ b/example-config.edn @@ -1,9 +1,11 @@ { :destinations [ { - :discord-wh "http://WH" - :bot-name "Your bot name here" - :bot-picture "URL to your bot avatar here" + :discord-wh { + :url "http://WH" + :bot-name "Your bot name here" + :bot-picture "URL to your bot avatar here" + } :relevant-entities { :corporation-ids [] :alliance-ids [1354830081] diff --git a/project.clj b/project.clj index 96dfc66..0906a80 100644 --- a/project.clj +++ b/project.clj @@ -1,8 +1,8 @@ -(defproject killbot "0.3.0-SNAPSHOT" +(defproject org.red/ares "0.3.0-SNAPSHOT" :description "FIXME: write description" :url "http://example.com/FIXME" - :license {:name "Eclipse Public License" - :url "http://www.eclipse.org/legal/epl-v10.html"} + :license {:name "MIT" + :url "https://opensource.org/licenses/MIT"} :dependencies [[org.clojure/clojure "1.8.0"] [org.clojure/tools.logging "0.4.0"] [ch.qos.logback/logback-classic "1.2.3"]