README.md in yahoo-finance-1.0.0 vs README.md in yahoo-finance-1.1.0
- old
+ new
@@ -1,19 +1,15 @@
# Ruby's Yahoo Finance Wrapper
A dead simple wrapper for yahoo finance quotes end-point.
## Installation:
-`gem install 'yahoo-finance'`
-`require 'yahoo-finance'`
+Just add it to your `Gemfile`:
-If using bundler:
+`gem 'yahoo-finance'`
-`gem 'yahoo-finance', git: 'https://github.com/herval/yahoo-finance.git'`
-`require: 'yahoo-finance'`
-
## Usage:
### Getting latest quotes for a set of symbols
Pass an array of valid symbols (stock names, indexes, exchange rates) and a list of fields you want:
@@ -37,11 +33,11 @@
data[0].ask # This is now a float
```
The full list of fields follows:
-``` ruby
+```ruby
:after_hours_change_real_time
:annualized_gain
:ask
:ask_real_time
:ask_size
@@ -115,10 +111,12 @@
:price_eps_estimate_current_year
:price_eps_Estimate_next_year
:price_paid
:price_per_book
:price_per_sales
+ :revenue
+ :shares_outstanding
:shares_owned
:short_ratio
:stock_exchange
:symbol
:ticker_trend
@@ -131,20 +129,20 @@
### Getting symbols by stock market (beta)
Create a YahooFinance::Client instance
```ruby
-yahoo_client = YahooClient::Client.new
+yahoo_client = YahooFinance::Client.new
```
Calling symbols_by_market method (symbols_by_market(country, stock_market))
Note: Can only be called with US Stock Markets for now.
*Important: This data comes directly from NASDAQ's CSV endpoints, NOT Yahoo Finance*. It might be extracted into a different Gem in the future.
```ruby
-yahoo_client.symbols_by('us', 'nyse') # Only US Stock Markets For Now
+yahoo_client.symbols_by_market('us', 'nyse') # Only US Stock Markets For Now
```
This method returns an array of symbols that can be used with the quotes method
```ruby