Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

Commit e7d942c

Browse files
Merge pull request #68 from logux/better-install
Improve install instructions
2 parents f41e761 + 19b0866 commit e7d942c

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
[![Build Status](https://travis-ci.org/logux/logux_rails.svg?branch=master)](https://travis-ci.org/logux/logux_rails) [![Coverage Status](https://coveralls.io/repos/github/logux/logux_rails/badge.svg?branch=master)](https://coveralls.io/github/logux/logux_rails?branch=master)
44

5+
Add WebSockets, live-updates and offline-first to Ruby on Rails with [Logux](https://github.com/logux/logux/). This gem will add [Logux Back-end Protocol](https://github.com/logux/logux/blob/master/backend-protocol/spec.md) to Ruby on Rails and then you can use Logux Server as a proxy between WebSocket and your Rails application.
6+
7+
Read [Creating Logux Proxy](https://github.com/logux/logux/blob/master/2-starting/2-creating-proxy.md) guide.
8+
59
## Installation
610

711
Add this line to your application's Gemfile:
@@ -16,19 +20,13 @@ And then execute:
1620
bundle
1721
```
1822

19-
Or install it yourself as:
20-
21-
```bash
22-
gem install logux_rails
23-
```
24-
2523
## Usage
2624

2725
First of all, you have to configure Logux, by defining server address in, for example, `config/initializers/logux.rb`:
2826

2927
```ruby
3028
Logux.configuration do |config|
31-
config.logux_host = 'http://localhost:3333'
29+
config.logux_host = 'http://localhost:31338'
3230
end
3331
```
3432

0 commit comments

Comments
 (0)