Skip to content

Commit ba16bf3

Browse files
authored
Update readme (#259)
* Remove mention of `ruby_lsp_rails.server` from readme * Fix link in readme
1 parent 7911cee commit ba16bf3

File tree

1 file changed

+1
-14
lines changed

1 file changed

+1
-14
lines changed

README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,6 @@ group :development do
1515
gem "ruby-lsp-rails"
1616
end
1717
```
18-
Some features rely on server introspection, and use a Rack server which is automatically mounted by using a Railtie.
19-
20-
For applications with specialized routing requirements, such as custom sharding, this may not be compatible. It can
21-
be disabled with:
22-
23-
```ruby
24-
# config/environments/development.rb
25-
Rails.application.configure do
26-
# ...
27-
config.ruby_lsp_rails.server = false
28-
# ...
29-
end
30-
```
3118

3219
## Usage
3320

@@ -53,7 +40,7 @@ See the [documentation](https://shopify.github.io/ruby-lsp-rails) for more in-de
5340
## How It Works
5441

5542
When Ruby LSP Rails starts, it spawns a `rails runner` instance which runs
56-
`[server.rb](https://github.com/Shopify/ruby-lsp-rails/blob/main/lib/ruby_lsp/ruby_lsp_rails/server.rb)`.
43+
[`server.rb`](https://github.com/Shopify/ruby-lsp-rails/blob/main/lib/ruby_lsp/ruby_lsp_rails/server.rb).
5744
The addon communicates with this process over a pipe (i.e. `stdin` and `stdout`) to fetch runtime information about the application.
5845

5946
When extension is stopped (e.g. by quitting the editor), the server instance is shut down.

0 commit comments

Comments
 (0)