1. Michael Granger
  2. ruby-pg

Commits

Michael Granger  committed 6723d3c

Adding a "Usage" section

  • Participants
  • Parent commits f106990
  • Branches default

Comments (0)

Files changed (1)

File Home.wiki

View file
  • Ignore whitespace
 
 On **Ubuntu**, /usr/bin/pg_config is provided by the libpq-dev package.
 
+== Usage ==
+
+The library comes with full API documentation; if you don't wish to build it yourself you can find copies of it online in either [[http://deveiate.org/code/pg/|RDoc]] or [[http://rubydoc.info/gems/pg/0.11.0/frames|YARD]] output formats.
+
+You'll want to check out the {{{PGconn}}} class first, and then once you have a result, that'll be an instance of the {{{PGresult}}} class.
+
+You can also check out some working examples in the [[https://bitbucket.org/ged/ruby-pg/src/3d744d9776c3/sample/|sample directory]] in the source.
+
+If you get stuck, drop by #ruby-lang on Freenode IRC; my nick is 'ged', and there are usually other people that can help. Or feel free to contact me via my @FaerieMUD email address, which you can find via `gem spec pg email`.
+
+
 == Copying ==
 
 This library is copyrighted by the authors.