Skip to content

Commit 70d62f0

Browse files
authored
Update README.md
1 parent a3e4171 commit 70d62f0

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

  • ruby/sqlcommenter-ruby/sqlcommenter_rails

ruby/sqlcommenter-ruby/sqlcommenter_rails/README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ Powered by [marginalia] and [marginalia-opencensus].
1111

1212
## Installation
1313

14+
Currently, this gem is not released on rubygems.
15+
But can be installed from source.
16+
17+
The gem depends requires functionality provided by an [open PR](https://github.com/basecamp/marginalia/pull/89) to [marginalia](https://github.com/basecamp/marginalia). Install the PR by cloning [glebm's fork of marginalia](https://github.com/glebm/marginalia) one directory above this folder.
18+
19+
```bash
20+
git clone https://github.com/glebm/marginalia.git ../marginalia
21+
```
22+
1423
Add the following lines to your application's Gemfile:
1524

1625
```ruby
@@ -19,19 +28,14 @@ gem 'marginalia', path: '../marginalia'
1928
gem 'marginalia-opencensus', path: '../marginalia-opencensus'
2029
```
2130

22-
Ensure Bundler is configured to access private repositories:
23-
24-
1. Generate an OAuth Token from GitHub with all the `repo` permissions by following
25-
[this guide](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).
26-
2. Configure bundler to use the OAuth token:
31+
Install dependencies:
2732

28-
```bash
29-
bundle config --local GITHUB__COM myoauthtoken:x-oauth-basic
30-
```
33+
```bash
34+
bin/setup
35+
```
3136

32-
And then execute:
37+
Please look at the [sqlcommenter_rails_demo](https://github.com/google/sqlcommenter/tree/master/ruby/sqlcommenter-ruby/sqlcommenter_rails_demo#sqlcommenter_rails-demo) for an example on how to install and use this gem in your project.
3338

34-
$ bundle
3539

3640
## Usage
3741

0 commit comments

Comments
 (0)