Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to have example visual and list out the routes available #14

Merged
merged 1 commit into from
Feb 16, 2021
Merged

Update README to have example visual and list out the routes available #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# 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:

Expand Down
Binary file added README_example.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.