Merge pull request #5 from rspec-parameterized/doc

Write doc

Author: sue445

README.md

@@ -1,24 +1,39 @@
 # Rspec::Parameterized::TableSyntax
+`rspec-parameterized-table_syntax` provides table syntax extension for [rspec-parameterized](https://github.com/tomykaira/rspec-parameterized).
 
-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/rspec/parameterized/table_syntax`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/rspec-parameterized-table_syntax.svg)](https://badge.fury.io/rb/rspec-parameterized-table_syntax)
+[![RSpec](https://github.com/rspec-parameterized/rspec-parameterized-table_syntax/actions/workflows/rspec.yml/badge.svg)](https://github.com/rspec-parameterized/rspec-parameterized-table_syntax/actions/workflows/rspec.yml)
 
 ## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_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.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+# Install all components
+group :test do
+  gem "rspec-parameterized", ">= 1.0.0"
+end
+
+# Install only rspec-parameterized-table_syntax
+group :test do
+  gem "rspec-parameterized-table_syntax", ">= 1.0.0"
+end
+```
 
 ## Usage
-
-TODO: Write usage instructions here
+### Table Syntax Style (like Groovy spock)
+```ruby
+describe "plus" do
+  using RSpec::Parameterized::TableSyntax
+  where(:a, :b, :answer) do
+    1 | 2 | 3
+    5 | 8 | 13
+    0 | 0 | 0
+  end
+  with_them do
+    it "should do additions" do
+      expect(a + b).to eq answer
+    end
+  end
+end
+```
 
 ## Development
 
@@ -28,7 +43,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]/rspec-parameterized-table_syntax.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rspec-parameterized/rspec-parameterized-table_syntax.
 
 ## License