Skip to content

Commit b101e52

Browse files
committed
Improve README and project description
1 parent 70cd49a commit b101e52

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed

README.rst

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,12 @@ CrateDB Ruby Client
1717

1818
|
1919
20-
A Ruby client library for CrateDB_.
20+
A Ruby client library for the CrateDB HTTP interface.
21+
22+
- Query execution support.
23+
- DDL command and schema introspection shortcuts.
24+
- Support for BLOB tables.
25+
- Foundation for the `activerecord-crate-adapter`_.
2126

2227

2328
*************
@@ -31,7 +36,7 @@ You will need Ruby 2.0 or greater.
3136
Installation
3237
************
3338

34-
The CrateDB Ruby client is available as a Ruby gem_.
39+
The CrateDB Ruby client is available on RubyGems.org, see `crate_ruby on RubyGems.org`_.
3540

3641
To use it, add this line to your application's ``Gemfile``::
3742

@@ -52,13 +57,13 @@ Set up the client.
5257
5358
require 'crate_ruby'
5459
55-
client = CrateRuby::Client.new
60+
client = CrateRuby::Client.new()
5661
5762
Execute SQL queries.
5863

5964
.. code:: ruby
6065
61-
result = client.execute("Select * from posts")
66+
result = client.execute("SELECT * FROM posts")
6267
=> #<CrateRuby::ResultSet:0x00000002a9c5e8 @rowcount=1, @duration=5>
6368
6469
result.each do |row|
@@ -118,6 +123,15 @@ SSL can be enabled.
118123
CrateRuby::Client.new(['localhost:4200'], ssl: true)
119124
120125
126+
*****
127+
Notes
128+
*****
129+
130+
See also `CrateDB examples for Ruby`_ for a basic example program, which
131+
exercises both the `crate_ruby`_ driver, as well as Ruby's canonical `pg`_
132+
driver.
133+
134+
121135
************
122136
Contributing
123137
************
@@ -136,9 +150,15 @@ Looking for more help?
136150

137151
- Check out our `support channels`_
138152

153+
154+
.. _activerecord-crate-adapter: https://github.com/crate/activerecord-crate-adapter
139155
.. _contribution docs: CONTRIBUTING.rst
140156
.. _Crate.IO GmbH: https://crate.io
141157
.. _CrateDB: https://github.com/crate/crate
158+
.. _CrateDB examples for Ruby: https://github.com/crate/cratedb-examples/tree/main/by-language/ruby
159+
.. _crate_ruby: https://rubygems.org/gems/crate_ruby
160+
.. _crate_ruby on RubyGems.org: https://rubygems.org/gems/crate_ruby
142161
.. _developer docs: DEVELOP.rst
143162
.. _gem: https://rubygems.org/
163+
.. _pg: https://rubygems.org/gems/pg
144164
.. _support channels: https://crate.io/support/

crate_ruby.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
3030
spec.authors = ['Christoph Klocker', 'Crate.IO GmbH']
3131
spec.email = ['office@crate.io']
3232
spec.summary = 'CrateDB HTTP client library for Ruby'
33-
spec.description = 'A Ruby interface for CrateDB featuring query support, DDL command shortcuts, and support for BLOB tables'
33+
spec.description = 'A Ruby library for the CrateDB HTTP interface with query support, DDL command and schema introspection shortcuts, and support for BLOB tables.'
3434
spec.homepage = 'https://crate.io'
3535
spec.license = 'Apache-2.0'
3636
spec.required_ruby_version = '>= 2.4'

0 commit comments

Comments
 (0)