Skip to content

Commit ee8f57d

Browse files
authored
Update README.md
Removed outdated links.
1 parent 151d333 commit ee8f57d

File tree

1 file changed

+14
-19
lines changed

1 file changed

+14
-19
lines changed

README.md

+14-19
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
[![npm](https://img.shields.io/npm/v/react_ujs.svg?style=flat-square)](https://www.npmjs.com/package/react_ujs)
55
[![Ruby](https://github.com/reactjs/react-rails/actions/workflows/ruby.yml/badge.svg)](https://github.com/reactjs/react-rails/actions/workflows/ruby.yml)
66

7-
## News
8-
V3.0.0 is released with Shakapacker v7 support, including SSR. Please try it out and report any issues. We'll try to address any critical issues ASAP.
9-
107
For version 2.7 documentation, visit the [2.7-stable](https://github.com/reactjs/react-rails/tree/2.7-stable) branch.
118

129
## Summary
@@ -16,6 +13,14 @@ React-Rails is a flexible tool to use [React](http://facebook.github.io/react/)
1613
* Supports Sprockets 4.x, 3.x
1714
* Lets you use [JSX](http://facebook.github.io/react/docs/jsx-in-depth.html), [ES6](http://es6-features.org/), [TypeScript](https://www.typescriptlang.org/), [CoffeeScript](http://coffeescript.org/)
1815

16+
---
17+
18+
While ShakaCode will continue to support this gem, you might consider migrating to [React on Rails](https://github.com/shakacode/react_on_rails) or [React on Rails Pro with proper Node rendering](https://www.shakacode.com/react-on-rails-pro/).
19+
20+
Why? React on Rails code receives much more active development and testing. For example, consider the [ReactRailsUJS](https://github.com/reactjs/react-rails/blob/master/react_ujs/index.js) implementation compared to the [ReactOnRails Node package](https://github.com/shakacode/react_on_rails/tree/master/node_package) which is written in TypeScript. For another example, React on Rails has work underway to support the latest React features, such as [React Server Components](https://react.dev/reference/rsc/server-components).
21+
22+
You can find [migration to React on Rails steps here](https://github.com/reactjs/react-rails/blob/master/docs/migrating-from-react-rails-to-react_on_rails.md).
23+
1924
---
2025
## ShakaCode Support
2126

@@ -34,7 +39,7 @@ Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=
3439

3540
## Resources
3641
* [Click to join **React + Rails Slack**](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE). Then join the channel `#react-rails`.
37-
* If you are upgrading, you might consider migrating to the [react_on_rails](https://github.com/shakacode/react_on_rails) gem.
42+
* If upgrading, consider migrating to the [react_on_rails](https://github.com/shakacode/react_on_rails) gem.
3843
* Source code example utilizing React-Rails: https://github.com/BookOfGreg/react-rails-example-app
3944

4045
## Documentation
@@ -77,32 +82,24 @@ Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=
7782
- [HMR](docs/common-errors.md#hmr)
7883
- [Tests in component directory](docs/common-errors.md#tests-in-component-directory)
7984

80-
After reading this README file, additional information about React-Rails can be found in the Wiki page:
85+
After reading this README file, additional information about React-Rails can be found on the Wiki page:
8186
https://github.com/reactjs/React-Rails/wiki
82-
The Wiki page features a significant amount of additional information about React-Rails which includes instructional articles and answers to the most frequently asked questions.
87+
The Wiki page features a significant amount of additional information about React-Rails, including instructional articles and answers to the most frequently asked questions.
8388

8489
## Related Projects
8590

86-
- [webpacker-react](https://github.com/renchap/webpacker-react): Integration of React with Rails utilizing Webpack with Hot Module Replacement (HMR).
87-
- [The React on Rails Course](https://learnetto.com/users/hrishio/courses/the-free-react-on-rails-5-course) A video course which teaches the basics of React and how to get started using it in Rails with `react-rails`.
8891
- [react\_on\_rails](https://github.com/shakacode/react_on_rails): Integration of React with Rails utilizing Webpack, Redux, React-Router.
89-
- [react-rails-hot-loader](https://github.com/rmosolgo/react-rails-hot-loader) Simple live-reloader for `react-rails`.
92+
- [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/):React on Rails with Node rendering and many other performance enhancements.
9093
- [react-rails-benchmark_renderer](https://github.com/pboling/react-rails-benchmark_renderer) adds performance instrumentation to server rendering.
9194
- [Ruby Hyperstack](https://hyperstack.org/): Use Ruby to build reactive user interfaces with React.
9295

9396
## Contributing
9497

95-
🎉 Thanks for taking the time to contribute! 🎉
96-
97-
With 5 Million+ downloads of the react-rails Gem and another 2 Million+ downloads of react_ujs on NPM, you're helping the biggest React + Rails community!
98-
99-
By contributing to React-Rails, you agree to abide by the [code of conduct](https://github.com/reactjs/react-rails/blob/main/CODE_OF_CONDUCT.md).
100-
101-
You can always help by submitting patches or triaging issues. Even offering reproduction steps to issues is incredibly helpful!
98+
🎉 Thanks for taking the time to contribute! 🎉 See [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
10299

103100
# Supporters
104101

105-
The following companies support the development of this and other open-source projects maintained by ShakaCode by providing licenses to the ShakaCode team. ShakaCode stands by the usefulness of these products!
102+
The following companies provide licenses to the ShakaCode team, supporting the development of this and other open-source projects maintained by ShakaCode. ShakaCode stands by the usefulness of these products!
106103

107104
<br />
108105
<br />
@@ -130,5 +127,3 @@ The following companies support the development of this and other open-source pr
130127
<img alt="BrowserStack" src="https://user-images.githubusercontent.com/4244251/184881129-e1edf4b7-3ae1-4ea8-9e6d-3595cf01609e.png" height="55px">
131128
</picture>
132129
</a>
133-
134-
Please see our [Contribution guide](https://github.com/reactjs/react-rails/blob/main/CONTRIBUTING.md) for more info.

0 commit comments

Comments
 (0)