Merge pull request #180 from sue445/feature/go_gem_doc

Add go_gem doc

Author: sue445

gem/README.md

@@ -1,24 +1,35 @@
 # GoGem
+Helpers for compiling Go extensions for ruby
 
-TODO: Delete this and the text below, and describe your gem
+## Installation
+Add below.
 
-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/go_gem`. To experiment with that code, run `bin/console` for an interactive prompt.
+```ruby
+spec.add_dependency "go_gem"
+```
 
-## Installation
+See below for details.
 
-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.
+[/_tools/patch_for_go_gem/](/_tools/patch_for_go_gem/)
 
-Install the gem and add to the application's Gemfile by executing:
+## Usage
+### `create_go_makefile`
+`create_go_makefile` is an extension of `create_makefile`.
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Add a task and hacks to build Go against the `Makefile` generated by `create_makefile`.
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+e.g.
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+# ext/GEM_NAME/extconf.rb
 
-## Usage
+require "mkmf"
+require "go_gem/mkmf" # Append this
 
-TODO: Write usage instructions here
+# Use create_go_makefile instead of create_makefile
+# create_makefile("example/example")
+create_go_makefile("example/example")
+```
 
 ## Development
 
@@ -28,7 +39,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]/go_gem.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/go-gem-wrapper.
 
 ## License