glean 0.0.13 → 0.0.14

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 coverage
+Gemfile.lock
 InstalledFiles
 lib/bundler/man
 pkg

data/README.md

@@ -1,7 +1,38 @@
 # Glean - A data management tool for humans
 
+___Glean is experimental, expect breaking changes until v1.0.0___
+
+## About
+Glean targets __human curated__ datasets, with a goal of easy collaboration.
+
+Data is stored in the human readable data format, [TOML](https://github.com/mojombo/toml). You can think of it as Markdown for data. Each dataset is stored in a git repository, which makes it easy to track revisions, propose changes, and collaborate on datasets.
+
+Each file represents one piece of data (a hash of hashes). Filenames and directory structure are not significant to the data, but are useful for organization and human collaboration via Pull Requests.
+
+## Goals
+* Easily pull commonly used datasets into projects
+* Curate data using Pull Requests
+* Preserve attribution for contributors
+
+## Sources
+Glean datasets are available from three distinct sources:
+
+* [Core](http://github.com/glean) - Available via search, hosted on the Glean GitHub organization
+* TODO
+  * Contrib - Available via search (using --contrib)
+  * User - Directly available via URL
+
+## Installation
+```
+$ gem install glean
+```
+
+__Requirements:__
+* Git
+
 ## Command line
 ```
+$ glean help
 NAME
     glean - A data management tool for humans
 
@@ -9,7 +40,7 @@ SYNOPSIS
     glean [global options] command [command options] [arguments...]
 
 VERSION
-    0.0.12
+    0.0.13
 
 GLOBAL OPTIONS
     --help    - Show this message
@@ -23,6 +54,28 @@ COMMANDS
     search - Search for datasets
 ```
 
+### Examples
+```
+$ glean export countries --format=json
+{"name":"Andorra","code":"ad"}
+{"name":"United Arab Emirates","code":"ae"}
+{"name":"Afghanistan","code":"af"}
+...
+```
+```
+$ glean export us-states --format=yaml
+--- !ruby/hash:Hashie::Mash
+name: Alaska
+abbreviation: ak
+--- !ruby/hash:Hashie::Mash
+name: Alabama
+abbreviation: al
+--- !ruby/hash:Hashie::Mash
+name: Arkansas
+abbreviation: ar
+...
+```
+
 ## Rails
 
 Gemfile:
@@ -40,6 +93,10 @@ if Country.count == 0
 end
 ```
 
+```
+$ rake db:seed
+```
+
 ## Other Frameworks
 
 I'm not sure how you'd do it, but I want to make it easy. Open an issue, or better yet drop some code in a Pull Request.

data/lib/glean/version.rb

@@ -1,3 +1,3 @@
 module Glean
-  VERSION = '0.0.13'
+  VERSION = '0.0.14'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glean
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -212,7 +212,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,85 +0,0 @@
-PATH
-  remote: .
-  specs:
-    glean (0.0.13)
-      git (= 1.2.5)
-      gli (= 2.5.4)
-      hashie (= 2.0.3)
-      json (= 1.7.7)
-      octokit (= 1.24.0)
-      toml (= 0.0.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.3)
-    blankslate (2.1.2.4)
-    coderay (1.0.9)
-    diff-lcs (1.2.1)
-    faraday (0.8.7)
-      multipart-post (~> 1.1)
-    faraday_middleware (0.9.0)
-      faraday (>= 0.7.4, < 0.9)
-    git (1.2.5)
-    gli (2.5.4)
-    guard (1.6.2)
-      listen (>= 0.6.0)
-      lumberjack (>= 1.0.2)
-      pry (>= 0.9.10)
-      terminal-table (>= 1.4.3)
-      thor (>= 0.14.6)
-    guard-rspec (2.5.1)
-      guard (>= 1.1)
-      rspec (~> 2.11)
-    hashie (2.0.3)
-    json (1.7.7)
-    listen (0.7.3)
-    lumberjack (1.0.3)
-    method_source (0.8.1)
-    multi_json (1.7.2)
-    multipart-post (1.2.0)
-    netrc (0.7.7)
-    octokit (1.24.0)
-      addressable (~> 2.2)
-      faraday (~> 0.8)
-      faraday_middleware (~> 0.9)
-      hashie (~> 2.0)
-      multi_json (~> 1.3)
-      netrc (~> 0.7.7)
-    parslet (1.5.0)
-      blankslate (~> 2.0)
-    pry (0.9.12)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rake (10.0.3)
-    rb-fsevent (0.9.3)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
-    rspec-nc (0.0.5)
-      rspec (~> 2.9)
-      terminal-notifier (~> 1.4.2)
-    slop (3.4.4)
-    terminal-notifier (1.4.2)
-    terminal-table (1.4.5)
-    thor (0.17.0)
-    toml (0.0.3)
-      parslet
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  glean!
-  guard-rspec
-  pry
-  rake
-  rb-fsevent
-  rspec
-  rspec-nc