Skip to content

Commit a6410d1

Browse files
committed
add a notice to clarify that swagger_ui:dist:update should be run part of this gem
1 parent d6ed844 commit a6410d1

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,10 @@ end
104104

105105
To update Swagger UI from its [distribution](https://github.com/wordnik/swagger-ui), run `bundle exec rake swagger_ui:dist:update`. Examine the changes carefully.
106106

107+
NOTE: This action should be run part of this gem (not your application). In case if you want to
108+
make it up-to-date, clone the repo, run the rake task, examine the diff, fix any bugs, make sure
109+
tests pass and then send PR here.
110+
107111
### Enabling in a Rails-API Project
108112

109113
The grape-swagger-rails gem uses the Rails asset pipeline for its Javascript and CSS. Enable the asset pipeline with [rails-api](https://github.com/rails-api/rails-api).

0 commit comments

Comments
 (0)