diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..71a7644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on ["Keep a Changelog"](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [0.1.0-beta1] - 2021-01-31 + +Initial Beta Release 🎉 diff --git a/README.md b/README.md index fa19bd3..4873a77 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Asynqmon is a web based tool for monitoring and administrating Asynq queues and tasks. +## Compatibility + +Current version of Asynqmon is compatible with [Asynq v0.15 or above](https://github.com/hibiken/asynq/releases). + ## Installation ### Release binaries @@ -26,7 +30,10 @@ The `asynqmon` binary should be created in the current directory. ## Usage -To start the server, run +Asynqmon server needs to connect to redis server to serve data. +By default, it connects to redis server running on port 6379 locally, and the server listens on port 8080. + +To use the defaults, simply run and open http://localhost:8080. ```sh $ asynqmon @@ -38,6 +45,12 @@ Pass flags to specify port, redis server address, etc. $ asynqmon --port=3000 --redis_addr=localhost:6380 ``` +To see all available flags, run + +```sh +$ asynqmon --help +``` + ## License Asynqmon is released under the MIT license. See [LICENSE](https://github.com/hibiken/asynqmon/blob/master/LICENSE).