Merge pull request #18 from 3ldr0n/master

Release v1.0

Author: eaneto

README.org

@@ -1,38 +1,43 @@
-* GetRSTN
+* RSTNPy
 
-Download RSTN 1 second data from NOAA's site. Working for data after 2000.
+Library to work with RSTN 1 second data from NOAA's site. Working for data after 2000.
 
 ** Installation
 
 #+BEGIN_SRC bash
-pip install getrstn
+pip install rstnpy
 #+END_SRC
 
 ** How to use it
 
 #+BEGIN_SRC python
 import matplotlib.pyplot as plt
 
-from getrstn import GetRSTN
+from rstnpy import RSTN
 
 day = 16
 month = 10
 year = 2014
 path_to_files = "data/"
 station = "San vito"
 
-rstn = GetRSTN(day, month, year, path_to_files, station)
+rstn = RSTN(day, month, year, path_to_files, station)
 
-# Downloads, decompress the file and generate a dataframe.
-rstn.download_file()
-filename = rstn.decompress_file()
+# Search and download the file.
+filename = rstn.downloader.download_file()
+
+# Decompress the gzipped file into a text file.
+filename = rstn.decompress_file(filename)
+
+# Generate a dataframe from the data.
 df = rstn.create_dataframe()
 
-# Plots the data.
+# Plot the data.
 ax = rstn.plot()
+
 plt.plot()
 #+END_SRC
 
 ** Compatibility
 
-The library was tested with Python 3, and Python 2.7.
+The library works with Python 3.5+