cinc

README.Rmd

@@ -30,10 +30,12 @@ The following functions are implemented:
 ## Installation
 
 ```{r install-ex, eval=FALSE}
+install.packages("widgetcard", repos = "https://cinc.rud.is/")
+# or
 devtools::install_git("https://git.sr.ht/~hrbrmstr/widgetcard")
 # or 
 devtools::install_gitlab("hrbrmstr/widgetcard")
-# or
+# or (if you must)
 devtools::install_github("hrbrmstr/widgetcard")
 ```
 

README.md

@@ -1,2 +1,52 @@
+
+[![Travis-CI Build
+Status](https://travis-ci.org/hrbrmstr/widgetcard.svg?branch=master)](https://travis-ci.org/hrbrmstr/widgetcard)
+[![Coverage
+Status](https://codecov.io/gh/hrbrmstr/widgetcard/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/widgetcard)
+[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/widgetcard)](https://cran.r-project.org/package=widgetcard)
+
 # widgetcard
 
+Tools to Enable Easier Content Embedding in Tweets
+
+## Description
+
+Tools to Enable Easier Content Embedding in Tweets
+
+## What’s Inside The Tin
+
+The following functions are implemented:
+
+  - `card_widget`: Turn an htmlwidget into a web deployable, interactive
+    Twitter card
+  - `gg_preview`: Generate a Twitter Player card preview image from a
+    ggplot2 plot
+
+## Installation
+
+``` r
+devtools::install_git("https://git.sr.ht/~hrbrmstr/widgetcard")
+# or 
+devtools::install_gitlab("hrbrmstr/widgetcard")
+# or
+devtools::install_github("hrbrmstr/widgetcard")
+```
+
+## Usage
+
+See [the
+vignette](https://rud.is/dl/creating-interactive-player-cards.html).
+
+## widgetcard Metrics
+
+| Lang | \# Files |  (%) | LoC |  (%) | Blank lines |  (%) | \# Lines |  (%) |
+| :--- | -------: | ---: | --: | ---: | ----------: | ---: | -------: | ---: |
+| HTML |        1 | 0.09 | 370 | 0.47 |          31 | 0.20 |        1 | 0.00 |
+| R    |        7 | 0.64 | 327 | 0.41 |          66 | 0.42 |      168 | 0.48 |
+| Rmd  |        3 | 0.27 |  92 | 0.12 |          61 | 0.39 |      181 | 0.52 |
+
+## Code of Conduct
+
+Please note that this project is released with a [Contributor Code of
+Conduct](CONDUCT.md). By participating in this project you agree to
+abide by its terms.