From 1f56dbc01c34c37fd625e399d8dde21869265719 Mon Sep 17 00:00:00 2001 From: Adelmo Filho Date: Fri, 8 Mar 2019 22:51:26 -0300 Subject: [PATCH 1/2] readme update --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0509e66..cec2160 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) @@ -11,7 +12,13 @@ This package is a tribute to the 35 years of the publication of the collection o ## Installation -You can install the development version from Github with devtools: +You can install this package from CRAN: + +``` r +install.packages("tenispolaR") +``` + +Or you can install the development version from Github with devtools: ``` r devtools::install_github("adelmofilho/tenispolaR") @@ -24,6 +31,8 @@ This is a basic example which shows ZENIT-POLAR substitution cipher method of en ``` 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") +``` +```r +[1] "esse e um trabalho para os karas: o avesso dos coroas, o contrario dos caretas!" ``` - From 0268c94e4a7d6fd5168f9d74cfb4f04e5848d336 Mon Sep 17 00:00:00 2001 From: Adelmo Filho Date: Fri, 8 Mar 2019 22:57:17 -0300 Subject: [PATCH 2/2] readme update example --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cec2160..b7b10d1 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ ## 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 this package from CRAN: @@ -23,16 +24,18 @@ 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!" tenispolaR::encryption(x, key_from = "polar", key_to = "tenis") ``` -```r -[1] "esse e um trabalho para os karas: o avesso dos coroas, o contrario dos caretas!" + +``` +## [1] "esse e um trabalho para os karas: o avesso dos coroas, o contrario dos caretas!" ```