Skip to content

Commit 067779f

Browse files
committed
Try to make the intro more informative
1 parent 761179b commit 067779f

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# react-rails
1+
# React-Rails
22

33
[![Gem](https://img.shields.io/gem/v/react-rails.svg?style=flat-square)](http://rubygems.org/gems/react-rails)
4-
[![npm](https://img.shields.io/npm/v/react_ujs.svg)](https://www.npmjs.com/package/react_ujs)
4+
[![npm](https://img.shields.io/npm/v/react_ujs.svg?style=flat-square)](https://www.npmjs.com/package/react_ujs)
55
[![Build Status](https://img.shields.io/travis/reactjs/react-rails/master.svg?style=flat-square)](https://travis-ci.org/reactjs/react-rails)
66
[![Gemnasium](https://img.shields.io/gemnasium/reactjs/react-rails.svg?style=flat-square)](https://gemnasium.com/reactjs/react-rails)
77
[![Code Climate](https://img.shields.io/codeclimate/github/reactjs/react-rails.svg?style=flat-square)](https://codeclimate.com/github/reactjs/react-rails)
88

9+
10+
React-Rails is a flexible tool to use [React](http://facebook.github.io/react/) with Rails. It:
11+
* Automatically renders React server-side and client-side
12+
* Supports Webpacker 3.x, 2.x, 1.1+
13+
* Supports Sprockets 4.x, 3.x, 2.x
14+
* Lets you use [JSX](http://facebook.github.io/react/docs/jsx-in-depth.html), [ES6](), [Coffeescript]()
15+
916
React-Rails makes it easy to use [React](http://facebook.github.io/react/) and [JSX](http://facebook.github.io/react/docs/jsx-in-depth.html) in your Ruby on Rails (3.2 to 5+) application.
1017

1118
Automatic Server-side Rendering (SSR) for SEO benefits with **Webpacker** 1.1 to 3+ and Sprockets 2 to 4 support!
@@ -16,7 +23,6 @@ Example app code available here: https://github.com/BookOfGreg/react-rails-examp
1623
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1724

1825

19-
- [Learn more](#learn-more)
2026
- [Get started with Webpacker](#get-started-with-webpacker)
2127
- [File naming](#file-naming)
2228
- [Use with Asset Pipeline](#use-with-asset-pipeline)
@@ -43,19 +49,11 @@ Example app code available here: https://github.com/BookOfGreg/react-rails-examp
4349

4450
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
4551

46-
## Learn more
47-
- React's [Getting Started guide](https://facebook.github.io/react/docs/getting-started.html)
48-
- Use React & JSX [with Webpacker](#get-started-with-webpacker)
49-
- or [with the asset pipeline](#use-with-asset-pipeline)
50-
- [Rendering components in views](#view-helper)
51-
- or [Render directly in controller actions](#controller-actions)
52-
- [Generating components](#component-generator) in various formats
53-
- Automatically [camelizing props](#camelize-props)
54-
- [Server-side rendering](#server-side-rendering)
55-
- [`ReactRailsUJS`](#ujs) for mounting and unmounting components
56-
- [Upgrading](#upgrading) 2.3 to 2.4
57-
- [Related Projects](#related-projects)
58-
- [Contribute to](#contributing) the gem
52+
53+
The React-Rails Wiki has lots of additional information about React-Rails including many "how-to" articles and answers to the most frequently asked questions. Please browse the Wiki after finishing this README:
54+
55+
https://github.com/reactjs/React-Rails/wiki
56+
5957

6058
## Get started with Webpacker
6159

0 commit comments

Comments
 (0)