Skip to content

Commit 82104cc

Browse files
committed
Update README
- Added requirements. - Added a short quote from react-stdio.
1 parent 41f99ef commit 82104cc

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
# rails_react_stdio
22

3-
This is a simple rails wrapper for [react-stdio](https://github.com/mjackson/react-stdio).
3+
This is a simple Ruby on Rails wrapper for [react-stdio](https://github.com/mjackson/react-stdio).
4+
5+
If you're not familiar with react-stdio, here's a snippet from their repo:
6+
7+
> react-stdio lets you render React components on the server, regardless of the backend technology you're using.
8+
9+
## Requirements
10+
- [npm](https://www.npmjs.com/)
11+
- [react-stdio](https://github.com/mjackson/react-stdio)
12+
- [Ruby on Rails](http://rubyonrails.org/)
413

514
## Installation
615
Add `rails_react_stdio` to your gemfile:
@@ -19,7 +28,7 @@ end
1928

2029
## Usage
2130

22-
Using rails_react_stdio is very simple. You just need to provide a location to your component file, and any props you wish to pass to it as a hash.
31+
Using rails_react_stdio is very _simple_. You just need to provide a location to your component file, and any props you wish to pass to it as a hash.
2332

2433
```ruby
2534
path_to_component = ::Rails.application.assets['components/HelloWorld'].filename

0 commit comments

Comments
 (0)