README.md in rake-ui-0.0.1 vs README.md in rake-ui-0.1.0

- old
+ new

@@ -1,15 +1,25 @@ # RakeUi Rake UI is a Rails engine that enables the discovery and execution rake tasks in a UI. +![Example](./README_example.gif) + +## Routes + +NOTE: Relative to mountpoint in application + + - GET /rake_tasks(.html/.json) - list all available rake tasks + - GET /rake_tasks/:id(.html/.json) - list info a single tasks + - POST /rake_tasks/:id/execute - execute a rake task + - GET /rake_task_logs(.html/.json) - list rake task history + - GET /rake_task_logs/:id(.html/.json) - list a single rake task history + ## Installation Add this line to your application's Gemfile: ```ruby -group :development do - gem 'rake-ui' -end +gem 'rake-ui' ``` And then execute: ```bash $ bundle @@ -32,10 +42,16 @@ ### Securing RakeUi This tool is built to enable developer productivity in development. It exposes rake tasks through a UI. -This tool will currently not work in production because we add a guard in the root controller to respond not found if the environment is development or test. +This tool will currently not work in production because we add a guard in the root controller to respond not found if the environment is development or test. You may override this guard clause with the following configuration. + +```rb +RakeUi.configuration do |config| + config.allow_production = true +end +``` We recommend adding guards in your route to ensure that the proper authentication is in place to ensure that users are authenticated so that if this were ever to be rendered in production, you would be covered. The best way for that is [router constraints](https://guides.rubyonrails.org/routing.html#specifying-constraints) ## Testing