Skip to content

Commit

Permalink
update DOI and citation
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Jan 22, 2024
1 parent 630dd7d commit 1d82ccb
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 10 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: secretbase
Type: Package
Title: Cryptographic Hash and Extendable-Output Functions
Version: 0.1.0
Version: 0.1.0.9000
Description: SHA-3 cryptographic hash and SHAKE256 extendable-output functions
(XOF). The SHA-3 Secure Hash Standard was published by the National
Institute of Standards and Technology (NIST) in 2015 at
Expand Down
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# secretbase 0.1.0.9000 (development)

# secretbase 0.1.0

* Initial CRAN release.
Expand Down
7 changes: 3 additions & 4 deletions R/base.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@

#' Cryptographic Hashing Using the SHA-3 Algorithm
#'
#' Returns a SHA-3 hash of the supplied R object. Implementated from code used
#' by the the 'Mbed TLS' library under the Trusted Firmware Project.
#' Returns a SHA-3 hash of the supplied R object.
#'
#' @param x an object.
#' @param bits [default 256L] output size of the returned hash - uses the
Expand All @@ -59,8 +58,8 @@
#'
#' @return A character string, raw or integer vector depending on 'convert'.
#'
#' @details For argument 'x', a character string or raw vector (with no
#' attributes) is hashed 'as is'.
#' @details A character string or raw vector (with no attributes) is hashed 'as
#' is'.
#'
#' All other objects are hashed in-place, in a 'streaming' fashion, by R
#' serialization but without allocation of the serialized object. To ensure
Expand Down
1 change: 1 addition & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ knitr::opts_chunk$set(
[![secretbase status badge](https://shikokuchuo.r-universe.dev/badges/secretbase?color=e4723a)](https://shikokuchuo.r-universe.dev/secretbase)
[![R-CMD-check](https://github.com/shikokuchuo/secretbase/workflows/R-CMD-check/badge.svg)](https://github.com/shikokuchuo/secretbase/actions)
[![codecov](https://codecov.io/gh/shikokuchuo/secretbase/graph/badge.svg)](https://app.codecov.io/gh/shikokuchuo/secretbase)
[![DOI](https://zenodo.org/badge/745691432.svg)](https://zenodo.org/doi/10.5281/zenodo.10553139)
<!-- badges: end -->

SHA-3 cryptographic hash and SHAKE256 extendable-output functions (XOF).
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ status](https://www.r-pkg.org/badges/version/secretbase?color=42147b)](https://C
badge](https://shikokuchuo.r-universe.dev/badges/secretbase?color=e4723a)](https://shikokuchuo.r-universe.dev/secretbase)
[![R-CMD-check](https://github.com/shikokuchuo/secretbase/workflows/R-CMD-check/badge.svg)](https://github.com/shikokuchuo/secretbase/actions)
[![codecov](https://codecov.io/gh/shikokuchuo/secretbase/graph/badge.svg)](https://app.codecov.io/gh/shikokuchuo/secretbase)
[![DOI](https://zenodo.org/badge/745691432.svg)](https://zenodo.org/doi/10.5281/zenodo.10553139)
<!-- badges: end -->

SHA-3 cryptographic hash and SHAKE256 extendable-output functions (XOF).
Expand Down
2 changes: 1 addition & 1 deletion inst/CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ bibentry(bibtype = "Manual",
author = person("Charlie", "Gao"),
year = 2024,
note = sprintf("R package version %s", meta$Version),
url = "https://shikokuchuo.net/secretbase/")
url = "https://doi.org/10.5281/zenodo.10553139")
7 changes: 3 additions & 4 deletions man/sha3.Rd

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

0 comments on commit 1d82ccb

Please sign in to comment.