Skip to content

Commit

Permalink
Doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
justin808 committed Dec 26, 2021
1 parent 05f1dda commit 32ab3cc
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Changes since last non-beta release.
### [12.5.0] - 2021-12-26

#### Added
- Added webpack configuration files as part of the generator and updated webpacker to version 6 [PR 1404](https://github.com/shakacode/react_on_rails/pull/1404) by [gscarv13](https://github.com/gscarv13).
- Support for React 18, including the changed SSR API. [PR 1409](https://github.com/shakacode/react_on_rails/pull/1409) by [kylemellander](https://github.com/kylemellander).
- Added webpack configuration files as part of the generator and updated webpacker to version 6. [PR 1404](https://github.com/shakacode/react_on_rails/pull/1404) by [gscarv13](https://github.com/gscarv13).
- Supports Rails 7.

#### Changed
Expand Down
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ For more information, feel free to contact Justin Gordon, [[email protected]]

# Documentation

See the documentation at [shakacode.com/react-on-rails/docs](https://www.shakacode.com/react-on-rails/docs/).
See the documentation at **[shakacode.com/react-on-rails/docs](https://www.shakacode.com/react-on-rails/docs/)**.

## Project Objective

Expand All @@ -55,22 +55,19 @@ Given that `rails/webpacker` gem already provides basic React integration, why w

See [Rails/Webpacker React Integration Options](https://www.shakacode.com/react-on-rails/docs/guides/rails-webpacker-react-integration-options) for comparisons to other gems.

See the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) for an example of a live implementation and code.

## Online demo

A deployed version of the project `spec/dummy` which demonstrates several uses of `react_on_rails` is available on heroku [through this link](https://ror-spec-dummy.herokuapp.com/)
* See the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) for an example of a live implementation and code.
* A deployed version of the project `spec/dummy` which demonstrates several uses of `react_on_rails` is available on heroku [through this link](https://ror-spec-dummy.herokuapp.com/)

## ShakaCode Forum Premium Content
_Requires creating a free account._

* [How to use different versions of a file for client and server rendering](https://forum.shakacode.com/t/how-to-use-different-versions-of-a-file-for-client-and-server-rendering/1352)
* [How to conditionally render server side based on the device type](https://forum.shakacode.com/t/how-to-conditionally-render-server-side-based-on-the-device-type/1473)


## Prerequisites

Ruby on Rails >=5 and rails/webpacker 4.2+.
Ruby on Rails >=5, rails/webpacker >= 4.2, Ruby >= 2.7

# Support

Expand Down
2 changes: 2 additions & 0 deletions rakelib/release.rake
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ which are installed via `bundle install` and `yarn global add release-it`
automatically perform a patch version bump.
2nd argument: Perform a dry run by passing 'true' as a second argument.
Note, accept defaults for npmjs options. Script will pause to get 2FA tokens.
Example: `rake release[2.1.0,false]`")
task :release, %i[gem_version dry_run tools_install] do |_t, args|
include ReactOnRails::TaskHelpers
Expand Down
4 changes: 2 additions & 2 deletions react_on_rails.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Gem::Specification.new do |s|
s.add_dependency "addressable"
s.add_dependency "connection_pool"
s.add_dependency "execjs", "~> 2.5"
s.add_dependency "rails", ">= 3.2"
s.add_dependency "rails", ">= 5.2"
s.add_dependency "rainbow", "~> 3.0"
s.add_dependency "webpacker", ">= 4.0"
s.add_dependency "webpacker", ">= 4.2"

s.add_development_dependency "bundler", "~> 2"
s.add_development_dependency "gem-release"
Expand Down

0 comments on commit 32ab3cc

Please sign in to comment.