Skip to content

Commit 83cbc5f

Browse files
committed
Add link to docs
1 parent 4a5c065 commit 83cbc5f

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,23 @@ group :development do
1515
end
1616
```
1717

18+
1819
## Usage
1920

21+
file:///Users/andyw8/src/github.com/Shopify/ruby-lsp-rails/docs/RubyLsp/Rails.html
22+
2023
### Hover to reveal ActiveRecord schema
2124

2225
1. Start your Rails server
2326
1. Hover over an ActiveRecord model to see its details
2427

2528
Nested models (e.g. `Admin::User`) are not yet supported.
2629

30+
### Documentation
31+
32+
See the [documentation](https://shopify.github.io/ruby-lsp-rails) for more in-depth details about the
33+
[supported features](https://shopify.github.io/ruby-lsp/RubyLsp/Rails.html).
34+
2735
### Running Tests
2836

2937
1. Open a test which inherits from `ActiveSupport::TestCase` or one if its descendants, such as `ActionDispatch::IntegrationTest`.

lib/ruby-lsp-rails.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
require "ruby_lsp_rails/railtie"
99

1010
module RubyLsp
11+
# # Supported features
12+
#
13+
# - [Hover](rdoc-ref:RubyLsp::Rails::Hover)
14+
# - [CodeLens](rdoc-ref:RubyLsp::Rails::CodeLens)
1115
module Rails
1216
end
1317
end

0 commit comments

Comments
 (0)