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

Commit

Permalink
Merge pull request #68 from logux/better-install
Browse files Browse the repository at this point in the history
Improve install instructions
  • Loading branch information
dsalahutdinov authored Jun 17, 2019
2 parents f41e761 + 19b0866 commit e7d942c
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

[![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)

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.

Read [Creating Logux Proxy](https://github.com/logux/logux/blob/master/2-starting/2-creating-proxy.md) guide.

## Installation

Add this line to your application's Gemfile:
Expand All @@ -16,19 +20,13 @@ And then execute:
bundle
```

Or install it yourself as:

```bash
gem install logux_rails
```

## Usage

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

```ruby
Logux.configuration do |config|
config.logux_host = 'http://localhost:3333'
config.logux_host = 'http://localhost:31338'
end
```

Expand Down

0 comments on commit e7d942c

Please sign in to comment.