README.md in stock_index-0.5.0 vs README.md in stock_index-0.5.1

- old
+ new

@@ -39,16 +39,34 @@ ```ruby { :market => 'XNYS', :symbol => 'MMM', - :name => '3M CO' + :name => '3M CO', + :wikipedia => 'http://en.wikipedia.org/wiki/3M', + :cik => '66740', + :bbgid => 'BBG000BP52R2' } ``` +| Key | Description | +| ----------| ----------- | +| market | Market symbol according to [ISO 10383](https://github.com/javiervidal/mic) | +| symbol | Component symbol | +| name | Component name according to [Bloomberg Open Symbology](http://bsym.bloomberg.com/sym/) | +| wikipedia | Link to the wikipedia page of the component | +| cik | Component CIK (Central Index Key) assigned to the company by the SEC | +| bbgid | BBGID (Bloomberg Security Identifier) according to [Bloomberg Open Symbology](http://bsym.bloomberg.com/sym/)| + +The name and cik are obtained querying the [EDGAR database](http://www.sec.gov/edgar/searchedgar/companysearch.html). + +The bbgid is obtained from [Bloomberg Open Symbology predefined files](http://bsym.bloomberg.com/sym/). + +The name, cik, and bbgid are cached using [PStore](http://ruby-doc.org/stdlib-1.9.2/libdoc/pstore/rdoc/PStore.html). + ## Contributing -1. Fork it ( http://github.com/<my-github-username>/stock_index/fork ) +1. Fork it ( http://github.com/javiervidal/stock_index/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request \ No newline at end of file