Skip to content

Commit b37e8a1

Browse files
committed
Improved docs about crypto
1 parent 803e211 commit b37e8a1

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,7 @@ o
219219
- [X] `base4`: conversion to quarternary (with a variant with a reversed alphabet)
220220
- [X] `base8`: simple conversion to octal (with a variant with a reversed alphabet)
221221
- [X] `base10`: simple conversion to decimal
222+
- [X] `base11`: conversion to digits with a "*a*"
222223
- [X] `base16`: simple conversion to hexadecimal (with a variant holding an alphabet with digits and letters inverted)
223224
- [X] `base26`: conversion to alphabet letters
224225
- [X] `base32`: classical conversion according to the RFC4648 with all its variants ([zbase32](https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt), extended hexadecimal, [geohash](https://en.wikipedia.org/wiki/Geohash), [Crockford](https://www.crockford.com/base32.html))

docs/enc/crypto.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,8 @@ This is a dynamic encoding, that is, it can be called with an integer to define
152152

153153
**Codec** | **Conversions** | **Aliases** | **Comment**
154154
:---: | :---: | --- | ---
155-
`rot` | text <-> rot(1) ciphertext | `rot1`, `rot-1`, `rot_1`, `caesar1` |
156-
`rot` | text <-> rot(X) ciphertext | ... |
157-
`rot` | text <-> rot(25) ciphertext | `rot25`, `rot-25`, `rot_25`, `caesar25` |
155+
`rot` | text <-> rot(1) ciphertext | `rot1`, `rot-1`, `rot_25`, `caesar13` | Dynamic ROT parameter ; belongs to [1, 26[
156+
`rot47` | text <-> rot47 ciphertext | |
158157

159158
```python
160159
>>> codext.encode("this is a test", "rot-15")
@@ -173,9 +172,7 @@ This is a dynamic encoding, that is, it can be called with an integer to define
173172

174173
**Codec** | **Conversions** | **Aliases** | **Comment**
175174
:---: | :---: | --- | ---
176-
`shift` | text <-> shift(1) ciphertext | `shift1`, `shift-1`, `shift_1` |
177-
`shift` | text <-> shift(X) ciphertext | ... |
178-
`shift` | text <-> shift(255) ciphertext | `shift255`, `shift-255`, `shift_255` |
175+
`shift` | text <-> shift(1) ciphertext | `shift1`, `shift-158`, `shift_255` | Dynamic shift parameter ; belongs to [1, 256[
179176

180177
```python
181178
>>> codext.encode("this is a test", "shift-3")
@@ -194,9 +191,7 @@ This is a dynamic encoding, that is, it can be called with an integer to define
194191

195192
**Codec** | **Conversions** | **Aliases** | **Comment**
196193
:---: | :---: | --- | ---
197-
`xor` | text <-> XOR(1) ciphertext | `XOR1`, `xor1`, `xor-1`, `xor_1` |
198-
`xor` | text <-> XOR(X) ciphertext | ... |
199-
`xor` | text <-> XOR(255) ciphertext | `XOR255`, `xor255`, `xor-255`, `xor_255` |
194+
`xor` | text <-> XOR(1) ciphertext | `XOR1`, `xor22`, `xor-158`, `xor_255` | Dynamic XOR parameter ; belongs to [1, 256[
200195

201196
```python
202197
>>> codext.encode("this is a test", "xor-10")

0 commit comments

Comments
 (0)