Skip to content

Commit

Permalink
Update and rename README.txt to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Karthik005 authored May 26, 2020
1 parent 0cd7a80 commit efa4a4d
Showing 1 changed file with 6 additions and 17 deletions.
23 changes: 6 additions & 17 deletions README.txt → README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
yfinanceapi (Equity and currency information API)
# yfinanceapi (Equity and currency information API)

Description
-----------
## Description

The yfinanceapi is an API for Python that builds on top of the Yahoo! finance JSON API to provide equity and currency information, such as price, volume, last trade time etc.

Installation
------------
## Installation

The API can be installed from PyPi using the following command:
pip install yfinanceapi
Expand All @@ -17,8 +15,7 @@ pip install git+https://github.com/Karthik005/yfinanceapi#egg=yfinanceapi

The installation may require root permissions.

Usage
-----
## Usage

The API can be imported in the following manner:

Expand All @@ -41,20 +38,12 @@ Currency values are measured with respect to USD.
Additional functions, information on usage and allowed symbol values can be found in the docstrings of the api.py file.


Copyright
---------
## Copyright

Copyright 2015, Karthik.S


License
-------
## License

This project is licensed under GNU v2.0. For more information read the LICENSE.txt file.


Bugs and requests
----------------

Bugs and feature requests can be reported at [email protected]

0 comments on commit efa4a4d

Please sign in to comment.