Skip to content

Commit

Permalink
Documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
castwide committed Apr 15, 2018
1 parent 7c638fc commit 36156f8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# VS Code Solargraph Extension

Solargraph provides code completion and inline documentation for Ruby.
Solargraph is a language server that provides intellisense, code completion, and inline documentation for Ruby.

![Screenshot](vscode-solargraph-0.16.0.gif)

*This project is still in early development.* Expect bugs and breaking changes.

## Features

* Context-aware suggestions and documentation for the Ruby core
Expand Down Expand Up @@ -119,8 +117,10 @@ This extension contributes the following settings:

* `solargraph.commandPath`: Path to the solargraph command. Set this to an absolute path to select from multiple installed Ruby versions.
* `solargraph.useBundler`: Use `bundle exec` to run solargraph. (If this is true, `solargraph.commandPath` is ignored.)
* `solargraph.bundlerPath`: Path to the bundle command.
* `solargraph.checkGemVersion`: Check if a new version of the Solargraph gem is available. Default is true (recommended).
* `solargraph.diagnostics`: The method to use for diagnostics (linting). Valid options are `rubocop` or `false` to disable.
* `solargraph.formatting`: The method to use for formatting. Valid options are `rubocop` or `false` to disable.

## Known Issues

Expand Down
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,16 @@
"license": "MIT",
"categories": [
"Languages",
"Snippets"
"Linters",
"Formatters"
],
"keywords": [
"Ruby",
"autocomplete",
"intellisense",
"YARD",
"code completion"
"code completion",
"language server"
],
"engines": {
"vscode": "^1.18.0"
Expand Down

0 comments on commit 36156f8

Please sign in to comment.