Skip to content

Commit

Permalink
Merge pull request #1 from adelmofilho/updateReadmeCRAN
Browse files Browse the repository at this point in the history
Update readme cran
  • Loading branch information
adelmofilho committed Mar 9, 2019
2 parents a8d7c5c + 0268c94 commit 1b3e510
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# tenispolaR <img src="man/figures/logo.png" align="right" height=140/>

[![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)
Expand All @@ -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!"
```

0 comments on commit 1b3e510

Please sign in to comment.