README

README.Rmd

@@ -39,6 +39,16 @@ packageVersion("f5wx")
 
 ```
 
+```{r ex01, fig.width=750/96, fig.height=450/96}
+library(ggplot2)
+
+f5wx_login()
+
+f5wx_forecast() %>% 
+  f5wx_chart() +
+  labs(title = "ECMWF Forecast for Berwick, Maine")
+```
+
 ## f5wx Metrics
 
 ```{r cloc, echo=FALSE}

README.md

@@ -0,0 +1,82 @@
+
+[![Project Status: Active – The project has reached a stable, usable
+state and is being actively
+developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![Signed
+by](https://img.shields.io/badge/Keybase-Verified-brightgreen.svg)](https://keybase.io/hrbrmstr)
+![Signed commit
+%](https://img.shields.io/badge/Signed_Commits-100%25-lightgrey.svg)
+[![Linux build
+Status](https://travis-ci.org/hrbrmstr/f5wx.svg?branch=master)](https://travis-ci.org/hrbrmstr/f5wx)  
+![Minimal R
+Version](https://img.shields.io/badge/R%3E%3D-3.5.0-blue.svg)
+![License](https://img.shields.io/badge/License-AGPL-blue.svg)
+
+# f5wx
+
+Orchestrate the Hidden API at F5 Weather
+
+## Description
+
+F5 Weather has great data but terrible forecast table aesthetics. Tools
+are provided to orchestrate and chart F5 Weather data.
+
+## What’s Inside The Tin
+
+The following functions are implemented:
+
+  - `f5wx_chart`: Make a temperature & precipitation chart from the
+    object returned by f5wx\_forecast()
+  - `f5wx_forecast`: Retrieve a forecast table from F5 Weather
+  - `f5wx_login`: Start a session to F5 Weather
+
+## Installation
+
+``` r
+remotes::install_git("https://git.rud.is/hrbrmstr/f5wx.git")
+# or
+remotes::install_git("https://git.sr.ht/~hrbrmstr/f5wx")
+# or
+remotes::install_gitlab("hrbrmstr/f5wx")
+```
+
+NOTE: To use the ‘remotes’ install options you will need to have the
+[{remotes} package](https://github.com/r-lib/remotes) installed.
+
+## Usage
+
+``` r
+library(f5wx)
+
+# current version
+packageVersion("f5wx")
+## [1] '0.1.0'
+```
+
+``` r
+library(ggplot2)
+
+f5wx_login()
+
+f5wx_forecast() %>% 
+  f5wx_chart() +
+  labs(title = "ECMWF Forecast for Berwick, Maine")
+```
+
+<img src="man/figures/README-ex01-1.png" width="750" />
+
+## f5wx Metrics
+
+| Lang | \# Files | (%) | LoC |  (%) | Blank lines | (%) | \# Lines |  (%) |
+| :--- | -------: | --: | --: | ---: | ----------: | --: | -------: | ---: |
+| R    |        4 | 0.4 | 161 | 0.46 |          26 | 0.3 |       59 | 0.33 |
+| Rmd  |        1 | 0.1 |  13 | 0.04 |          18 | 0.2 |       30 | 0.17 |
+| SUM  |        5 | 0.5 | 174 | 0.50 |          44 | 0.5 |       89 | 0.50 |
+
+clock Package Metrics for f5wx
+
+## Code of Conduct
+
+Please note that this project is released with a Contributor Code of
+Conduct. By participating in this project you agree to abide by its
+terms.