Skip to content

Commit

Permalink
Merge pull request #490 from seanpdoyle/mention-rubydocs-in-readme
Browse files Browse the repository at this point in the history
Mention RubyDoc page in README
  • Loading branch information
afcapel committed Aug 24, 2023
2 parents d1dd296 + 5d29b2b commit 037a307
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,12 @@ import "@hotwired/turbo-rails"

You can watch [the video introduction to Hotwire](https://hotwired.dev/#screencast), which focuses extensively on demonstrating Turbo in a Rails demo. Then you should familiarize yourself with [Turbo handbook](https://turbo.hotwired.dev/handbook/introduction) to understand Drive, Frames, and Streams in-depth. Finally, dive into the code documentation by starting with [`Turbo::FramesHelper`](https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/frames_helper.rb), [`Turbo::StreamsHelper`](https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/streams_helper.rb), [`Turbo::Streams::TagBuilder`](https://github.com/hotwired/turbo-rails/blob/main/app/models/turbo/streams/tag_builder.rb), and [`Turbo::Broadcastable`](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb).

### RubyDoc Documentation

For the API documentation covering this gem's classes and packages, [visit the
RubyDoc page][].

[visit the RubyDoc page](https://rubydoc.info/github/hotwired/turbo-rails/main)

## Compatibility with Rails UJS

Expand Down

0 comments on commit 037a307

Please sign in to comment.