Skip to content

Commit dc229f0

Browse files
committed
Puid notice
1 parent d2ce930 commit dc229f0

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ Efficiently generate cryptographically strong random strings of specified entrop
44

55
[![Build Status](https://travis-ci.org/EntropyString/Elixir.svg?branch=master)](https://travis-ci.org/EntropyString/Elixir)   [![Hex Version](https://img.shields.io/hexpm/v/entropy_string.svg "Hex Version")](https://hex.pm/packages/entropy_string)   [![License: MIT](https://img.shields.io/npm/l/express.svg)]()
66

7+
8+
## <center>NOTICE</center>
9+
10+
<hr/>
11+
12+
`EntropyString` is now superseded by [Puid](https://github.com/puid/Elixir).
13+
14+
`Puid` is based on the same logic as `EntropyString` but is [significantly faster](https://puid.github.io/Elixir/#EntropyString) for pre-defined character sets (which has been expanded to a total of [16 sets](https://hexdocs.pm/puid/Puid.CharSet.html#module-charsets)), as well as somewhat faster for custom characters, which can now be of any character count, as well as Unicode.
15+
16+
The `Puid` [generated API](https://puid.github.io/Elixir/#ModuleAPI) for modules has been simplified to two functions: `generate/0` and `info/0`.
17+
18+
`EntropyString` will not be removed. Although switching to `Puid` shouldn't be difficult, contact [Paul Rogers](https://hex.pm/users/dingosky) with any questions or need of assistance.
19+
20+
<hr/>
21+
722
### <a name="TOC"></a>TOC
823
- [Installation](#Installation)
924
- [Usage](#Usage)

mix.exs

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ defmodule EntropyString.Mixfile do
44
def project do
55
[
66
app: :entropy_string,
7-
version: "1.3.2",
7+
version: "1.3.3",
88
elixir: "~> 1.8",
99
deps: deps(),
1010
description: description(),
@@ -20,7 +20,7 @@ defmodule EntropyString.Mixfile do
2020

2121
defp description do
2222
"""
23-
Efficiently generate cryptographically strong random strings of specified entropy from various character sets.
23+
Efficiently generate cryptographically strong random strings of specified entropy from various character sets. `EntropyString` is superseded by `Puid` (https://hex.pm/packages/puid).
2424
"""
2525
end
2626

0 commit comments

Comments
 (0)