Skip to content

Commit dedac7c

Browse files
committed
Update README to have example visual and list out the routes available
1 parent 27dea30 commit dedac7c

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# RakeUi
22
Rake UI is a Rails engine that enables the discovery and execution rake tasks in a UI.
33

4+
![Example](./README_example.gif)
5+
6+
## Routes
7+
8+
NOTE: Relative to mountpoint in application
9+
10+
- GET /rake_tasks(.html/.json) - list all available rake tasks
11+
- GET /rake_tasks/:id(.html/.json) - list info a single tasks
12+
- POST /rake_tasks/:id/execute - execute a rake task
13+
- GET /rake_task_logs(.html/.json) - list rake task history
14+
- GET /rake_task_logs/:id(.html/.json) - list a single rake task history
15+
416
## Installation
517
Add this line to your application's Gemfile:
618

README_example.gif

1.48 MB
Loading

0 commit comments

Comments
 (0)