README.md in csi-0.1.0 vs README.md in csi-0.2.0
- old
+ new
@@ -1,33 +1,99 @@
The North American Industry Classification System (NAICS) is used by business and government to classify business establishments according to type of economic activity (process of production) in Canada, Mexico and the United States. It has largely replaced the older Standard Industrial Classification (SIC) system; however, certain government departments and agencies, such as the U.S. Securities and Exchange Commission (SEC), still use the SIC codes. CSI helps you look those codes up.
+# Installation
+
+This is a Ruby gem, so you'll need a little Ruby-fu to get it working. If you're not familiar with Ruby, there are CSV copies of the data sets available too that you can load into a spreadsheet, database or parse in your favorite programming language.
+
+#### For Rubyists:
+
+```
+gem install csi
+```
+
+Or add this to your `Gemfile`:
+
+```
+gem 'csi', '~> 0.1.0'
+```
+
+#### For everyone else:
+
+* SIC codes in [CSV](lib/data/sic/sic-code-lookup-2000.csv) or [TOML](lib/data/sic/sic-code-lookup-2000.toml)
+* NAICS codes in [CSV](lib/data/naics/naics-code-lookup-2012.csv) or [TOML](lib/data/naics/naics-code-lookup-2012.toml)
+
# Usage
```ruby
-csi::lookup_naics 336992
+CSI::lookup_naics 336992
# => Military Armored Vehicle, Tank, and Tank Component Manufacturing
-csi::lookup_naics 611310
+CSI::lookup_naics 611310
# => Colleges, Universities, and Professional Schools
-csi::lookup_naics 62
+CSI::lookup_naics 62
# => Health Care and Social Assistance
-csi::lookup_sic 6021
+CSI::lookup_sic 6021
# => National Commercial Banks
```
-# Contributing
+# NAICS vs SIC
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+<table>
+ <tbody>
+ <tr>
+ <th colspan="2">NAICS</td>
+ <th colspan="2">SIC</td>
+ </tr>
+ <tr>
+ <td>2-digit</td>
+ <td>Sector</td>
+ <td>Division</td>
+ <td>Letter</td>
+ </tr>
+ <tr>
+ <td>3-digit</td>
+ <td>Subsector</td>
+ <td>Major Group</td>
+ <td>2-digit</td>
+ </tr>
+ <tr>
+ <td>4-digit</td>
+ <td>Industry Group</td>
+ <td>Industry Group</td>
+ <td>3-digit</td>
+ </tr>
+ <tr>
+ <td>5-digit</td>
+ <td>NAICS Industry</td>
+ <td>Industry</td>
+ <td>4-digit</td>
+ </tr>
+ <tr>
+ <td>6-digit</td>
+ <td>National</td>
+ <td>N/A</td>
+ <td>N/A</td>
+ </tr>
+ </tbody>
+</table>
-# Copyright
+NAICS is a system that assigns a two-digit numerical code to each industry and 3 to 6 digits to each industry sub-sector. The larger the number, the more specific the industry. For example:
-Copyright (c) 2013 Lee Reilly. See LICENSE.txt for further details.
+```
+48-49 Transportation & Warehousing (over arching industry and sub-sectors)
+481 Air transportation
+4812 Nonscheduled air transportation
+48121 Nonscheduled air transportation
+481212 Nonscheduled chartered freight air transportation
+```
+
+## Data Sources
+
+All codes and classifications obtained via http://www.census.gov, so you know it's legit :metal:
+
+## Copyright
+
+Copyright (c) 2013 Lee Reilly. See LICENSE.md for further details.
\ No newline at end of file