add create_tag.sh and improve top level docs

Author: Naomi Slater

CONTRIBUTING.rst

@@ -1,93 +1,10 @@
-Contributing to Crate Ruby
-==========================
+============
+Contributing
+============
 
-Thanks for considering contributing to the Crate Data Ruby library.
+Thank you for your interest in contributing.
 
+Please see the CrateDB `contribution guide`_ for more information. Everything in
+the CrateDB contribution guide applies to this repository.
 
-Reporting an issue
-------------------
-
-- Search existing issues before raising a new one.
-
-- include as much details as possible. This might include:
-
-  - Which OS you're using.
-
-  - Which version you've been running.
-
-  - Logs/Stacktrace of the error that occurred.
-
-  - Steps to reproduce.
-
-
-Pull requests
--------------
-
-Before we can accept any pull requests to the Crate Data Ruby library
-we need you to agree to our CLA_. Once that is done, we suggest to
-continue as follows:
-
-- Add an issue on Github and let us know that you're working on something.
-
-- Use a feature branch, not master.
-
-- Rebase your feature branch onto origin/master before raising the PR
-
-- Be descriptive in your PR and commit messages. What is it for, why is it
-  needed, etc.
-
-- Make sure the tests pass.
-
-- Squash related commits
-
-.. _CLA: https://crate.io/community/contribute/
-
-
-Rebase
-------
-
-If while you've been working in the feature branch new commits were added to
-the master branch please don't merge them but use rebase::
-
-    git fetch origin
-    git rebase origin/master
-
-This will apply all commits on your feature branch on top of the master branch.
-Any conflicts can be resolved just the same as if ``git merge`` was used. After
-the conflict has been resolved use ``git rebase --continue`` to continue the
-rebase process.
-
-
-Squash
-------
-
-Minor commits that only fix typos or rename variables that are related to a
-bigger change should be squashed into that commit.
-
-This can be done using ``git rebase -i ( <hash> | <branch> )``
-
-For example while working on a feature branch you'd use::
-
-    git add .
-    git commit -m "implemented feature XY"
-
-    # push and ask for a merge/review
-
-    git add .
-    git commit --fixup $(git rev-parse HEAD)
-
-    # push and ask for a merge/review
-
-    git add .
-    git commit --fixup $(git rev-parse HEAD)
-
-    git rebase -i origin/master
-
-``git commit --fixup`` will mark the commit as a fixup relating to the commit
-HEAD currently points to.
-
-This is useful because ``git rebase -i`` will then automatically recognize the
-fixup commits and mark them to squash. But in order for that to work the
-``autosquash`` setting has to be enabled in the ``.gitconfig``::
-
-    git config --global rebase.autosquash true
+.. _contribution guide: https://github.com/crate/crate/blob/master/CONTRIBUTING.rst

DEVELOP.md

@@ -0,0 +1,46 @@
+===============
+Developer Guide
+===============
+
+Tests
+=====
+
+First, download and install CrateDB locally::
+
+    $ ruby spec/bootstrap.rb
+
+Then, run tests like so::
+
+    $ bundle exec rspec spec
+
+Preparing a Release
+===================
+
+To create a new release, you must:
+
+- Update ``CrateRuby.version`` in ``lib/crate_ruby/version.rb``
+
+- Add a section for the new version in the ``history.txt`` file
+
+- Commit your changes with a message like "prepare release x.y.z"
+
+- Push to origin
+
+- Create a tag by running ``./devtools/create_tag.sh``
+
+RubyGems Deployment
+===================
+
+Update your package manager::
+
+    $ gem update --system
+
+Build the new gem::
+
+    $ gem build crate_ruby.gemspec
+
+Publish the new gem::
+
+    $ gem push crate_ruby-<VERISON>.gem
+
+Here, ``<VERISON>`` is the version you are releasing.

DEVELOP.rst

@@ -0,0 +1,109 @@
+===================
+CrateDB Ruby Client
+===================
+
+.. image:: https://badge.fury.io/rb/crate_ruby.svg
+   :target: http://badge.fury.io/rb/crate_ruby
+   :alt: Gem Version
+
+.. image:: https://travis-ci.org/crate/crate_ruby.svg?branch=master
+   :target: https://travis-ci.org/crate/crate_ruby
+   :alt: Build Status
+
+.. image:: https://codeclimate.com/github/crate/crate_ruby.png
+   :target: https://codeclimate.com/github/crate/crate_ruby
+   :alt: Code Climate
+
+|
+
+A Ruby client library for CrateDB_.
+
+Prerequisites
+=============
+
+You will need Ruby 2.0 or greater.
+
+Installation
+============
+
+The CrateDB Ruby client is available as a Ruby gem_.
+
+Add this line to your application's ``Gemfile``::
+
+    gem 'crate_ruby'
+
+Or, install it manually, like so::
+
+    $ gem install crate_ruby
+
+Examples
+========
+
+Set up the client like so::
+
+    require 'crate_ruby'
+
+    client = CrateRuby::Client.new
+
+Execute SQL queries like so::
+
+    result = client.execute("Select * from posts")
+     => #<CrateRuby::ResultSet:0x00000002a9c5e8 @rowcount=1, @duration=5>
+
+    result.each do |row|
+      puts row.inspect
+    end
+     => [1, "test", 5]
+
+    result.cols
+     => ["id", "my_column", "my_integer_col"]
+
+
+Perform parameter substitution like so::
+
+     client.execute(
+         "INSERT INTO posts (id, title, tags) VALUES (\$1, \$2, \$3)",
+         [1, "My life with crate", ['awesome', 'cool']])
+
+Manipulate BLOBs like so::
+
+    digest = Digest::SHA1.file(file_path).hexdigest
+
+    # upload
+    f = File.read(file_path)
+    client.blob_put(table_name, digest, f)
+
+    # download
+    data = client.blob_get(table_name, digest)
+    open(file_path, "wb") do |file|
+      file.write(data)
+    end
+
+    # deletion
+    client.blob_delete(table_name, digest)
+
+Contributing
+============
+
+This project is primarily maintained by `Crate.io`_, but we welcome community
+contributions!
+
+See the `developer docs`_ and the `contribution docs`_ for more information.
+
+Help
+====
+
+Looking for more help?
+
+- Check `StackOverflow`_ for common problems
+- Chat with us on `Slack`_
+- Get `paid support`_
+
+.. _contribution docs: CONTRIBUTING.rst
+.. _Crate.io: https://crate.io
+.. _CrateDB: https://github.com/crate/crate
+.. _developer docs: DEVELOP.rst
+.. _gem: https://rubygems.org/
+.. _paid support: https://crate.io/pricing/
+.. _Slack: https://crate.io/docs/support/slackin/
+.. _StackOverflow: https://stackoverflow.com/tags/crate