cartodb-tools 0.0.8 → 0.0.9

data/README.md

@@ -1,21 +1,49 @@
-# Cartodb::Tools
+# cartodb-tools
 
-Import data into CartoDB from the command line.
+Command line tool to import and show details about data in your CartoDB account.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    gem install cartodb-tools
 
-    gem 'cartodb-tools'
+## Configuration
 
-And then execute:
+Configuration of your API credentials and server can either be done with a `.cartodbrc` file
+in your `$HOME` directory, or by using environment variables. The `.cartodbrc` file is a YAML
+file that contains your account information.
 
-    $ bundle
+Here is a sample `.cartodbrc` file:
 
-Or install it yourself as:
+```yaml
+host: 'https://username.cartodb.com'
+oauth_key: 'YOUR AUTH KEY'
+oauth_secret: 'YOUR AUTH SECRET'
+username: 'your username/email'
+password: 'your password'
+```
 
-    $ gem install cartodb-tools
+or, for environment variables:
+
+```sh
+export CARTODB_HOST="https://username.cartodb.com"
+export CARTODB_OAUTHKEY="YOUR AUTH KEY"
+export CARTODB_OAUTHSECRET="YOUR AUTH SECRET"
+export CARTODB_USERNAME="your username/email"
+export CARTODB_PASSWORD="your password"
+```
+
+Note: the environment variables override the settings in the `.cartodbrc` file. You can define a mix,
+so just your password can be an environment variable if you like.
 
 ## Usage
 
+There are 3 supported commands currently, `import`, `ls`, and `show`
+
     cartodb import -t "table_name" -f /path/to/some.csv -g Point
+
+    cartodb ls
+
+    cartodb show -t table_name
+
+Note: for some reason, the API is not naming the tables properly. This happens on the current cartodb.com
+hosted version and self-hosted instances.

data/lib/cartodb-tools/version.rb

@@ -1,3 +1,3 @@
 module CartodbTools
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cartodb-tools
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors: