Skip to content

Commit 4ee34ce

Browse files
authored
Merge pull request #217 from ruby-go-gem/fix_doc
Tweak doc
2 parents 1c36179 + 2f02722 commit 4ee34ce

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77
[![Go Report Card](https://goreportcard.com/badge/github.com/ruby-go-gem/go-gem-wrapper)](https://goreportcard.com/report/github.com/ruby-go-gem/go-gem-wrapper)
88
[![Go Reference](https://pkg.go.dev/badge/github.com/ruby-go-gem/go-gem-wrapper.svg)](https://pkg.go.dev/github.com/ruby-go-gem/go-gem-wrapper)
99

10+
## Overview
11+
| Directory | Name | API Reference |
12+
|------------------|-------------------------------------------------------|----------------------------------------------------------|
13+
| [/](/) | `github.com/ruby-go-gem/go-gem-wrapper` (Go module) | https://pkg.go.dev/github.com/ruby-go-gem/go-gem-wrapper |
14+
| [/_gem/](/_gem/) | [go_gem](https://rubygems.org/gems/go_gem) (Ruby gem) | https://ruby-go-gem.github.io/go-gem-wrapper/ |
15+
1016
## Requirements
1117
* Go
1218
* Ruby
@@ -119,21 +125,17 @@ However, some of the methods listed below are not supported.
119125

120126
## Developing
121127
### Build
122-
Run `rake ruby:build_example`. (`bundle exec` is not required)
128+
Run `bundle exec rake ruby:example:build`.
123129

124-
See `rake -T` for more tasks.
130+
See `bundle exec rake -T` for more tasks.
125131

126132
### See `godoc` in local
127133
```bash
128134
go install golang.org/x/tools/cmd/godoc@latest
129135
godoc
130136
```
131137

132-
open http://localhost:6060/pkg/github.com/ruby-go-gem/go-gem-wrapper/
133-
134-
## Reference
135-
* Go: https://pkg.go.dev/github.com/ruby-go-gem/go-gem-wrapper
136-
* Ruby: https://ruby-go-gem.github.io/go-gem-wrapper/
138+
open http://localhost:6060/pkg/github.com/ruby-go-gem/go-gem-wrapper/ruby/
137139

138140
## Original idea
139141
[Ruby meets Go - RubyKaigi 2015](https://rubykaigi.org/2015/presentations/mmasaki/)

0 commit comments

Comments
 (0)