Skip to content

Commit

Permalink
rename functions to R convention
Browse files Browse the repository at this point in the history
  • Loading branch information
bbartholdy committed Jul 5, 2024
1 parent d63cf94 commit 380c091
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 9 deletions.
2 changes: 1 addition & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

export(is_it_safe)
export(is_it_secret)
export(keepitsafe)
export(keep_it_safe)
importFrom(utils,globalVariables)
5 changes: 4 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ knitr::opts_chunk$set(
This package will help you generate a strong password. Even better, the password
will contain words straight out of the Lord of the Rings novel!

It was heavily inspired by [this xkcd comic](https://xkcd.com/936/) and
[this Phoenix Nap blog post](https://phoenixnap.com/blog/strong-great-password-ideas).

## Installation

You can install the development version of keepitsecret like so:
Expand All @@ -38,7 +41,7 @@ To generate a password.

```{r generate}
library(keepitsecret)
pw <- keepitsafe()
pw <- keep_it_safe()
pw
```

Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
This package will help you generate a strong password. Even better, the
password will contain words straight out of the Lord of the Rings novel!

It was heavily inspired by [this xkcd comic](https://xkcd.com/936/) and
[this Phoenix Nap blog
post](https://phoenixnap.com/blog/strong-great-password-ideas).

## Installation

You can install the development version of keepitsecret like so:
Expand All @@ -27,9 +31,9 @@ To generate a password.

``` r
library(keepitsecret)
pw <- keepitsafe()
pw <- keep_it_safe()
pw
#> [1] "refreshed notion puffing network"
#> [1] "Folco-Imladris-objection-bread"
```

You can also test whether a password has been part of a data breach (is
Expand All @@ -53,7 +57,7 @@ Beware of common

``` r
is_it_secret("password1234")
#> ! Password found in database 48483 times
#> ! Password found in database 48725 times
```

and weak passwords!
Expand Down
17 changes: 17 additions & 0 deletions keepitsecret.Rproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Version: 1.0

RestoreWorkspace: Default
SaveWorkspace: Default
AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
LaTeX: pdfLaTeX

BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
8 changes: 4 additions & 4 deletions man/keepitsafe.Rd → man/keep_it_safe.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 380c091

Please sign in to comment.