diff --git a/README.md b/README.md index 0509e66..b7b10d1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # tenispolaR +[![CRAN status](https://www.r-pkg.org/badges/version/tenispolaR)](https://cran.r-project.org/package=tenispolaR) [![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable) [![Travis build status](https://travis-ci.org/adelmofilho/tenispolaR.svg?branch=master)](https://travis-ci.org/adelmofilho/tenispolaR) [![Coverage status](https://codecov.io/gh/adelmofilho/tenispolaR/branch/master/graph/badge.svg)](https://codecov.io/github/adelmofilho/tenispolaR?branch=master) @@ -8,22 +9,33 @@ ## Background This package is a tribute to the 35 years of the publication of the collection of books "Os Karas" by the Brazilian author Pedro Bandeira. - + + ## Installation -You can install the development version from Github with devtools: +You can install this package from CRAN: ``` r -devtools::install_github("adelmofilho/tenispolaR") +install.packages("tenispolaR") ``` +Or you can install the development version from Github with devtools: + +``` r +devtools::install_github("adelmofilho/tenispolaR") +``` + + ## Example -This is a basic example which shows ZENIT-POLAR substitution cipher method of encryption +This is a basic example which shows ZENIT-POLAR substitution cipher method of encryption. -``` r +```r x <- "orro o um psibinhe tisi er kisir: e ivorre der ceseir, e celpsisae der cisopir!" -encryption(x, key_from = "polar", key_to = "tenis") +tenispolaR::encryption(x, key_from = "polar", key_to = "tenis") ``` +``` +## [1] "esse e um trabalho para os karas: o avesso dos coroas, o contrario dos caretas!" +```