Skip to content

Commit

Permalink
Write the README file
Browse files Browse the repository at this point in the history
fixes #3
  • Loading branch information
kozy4324 committed Nov 29, 2024
1 parent 0e23599 commit dedd8e2
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Ruby::Lsp::Rake
# ruby-lsp-rake

TODO: Delete this and the text below, and describe your gem

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruby/lsp/rake`. To experiment with that code, run `bin/console` for an interactive prompt.
A Ruby LSP addon that adds extra editor functionality for Rake.

## Installation

TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
If you haven't already done so, you'll need to first [set up Ruby LSP](https://shopify.github.io/ruby-lsp/#usage).

Install the gem and add to the application's Gemfile by executing:

```bash
bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
bundle add ruby-lsp-rake --group development
```

If bundler is not being used to manage dependencies, install the gem by executing:

```bash
gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
gem install ruby-lsp-rake
```

## Usage
## Features

### Dependency task links on hover

TODO: Write usage instructions here
Add a link to the location where the dependency task is defined to the hover content.

## Development

Expand All @@ -32,7 +32,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby-lsp-rake.
Bug reports and pull requests are welcome on GitHub at https://github.com/kozy4324/ruby-lsp-rake.

## License

Expand Down

0 comments on commit dedd8e2

Please sign in to comment.