Skip to content

Commit 41bfb8f

Browse files
committed
improve README.rst
1 parent d26b370 commit 41bfb8f

1 file changed

Lines changed: 9 additions & 21 deletions

File tree

README.rst

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This is a cryptographic library implementing the camellia cipher in python.
88
99
>>> import camellia
1010
>>> plain = b"This is a text. "
11-
>>> c1 = camellia.CamelliaCipher(key=b'16 byte long key', IV=b'16 byte iv. xxxx', mode=camellia.MODE_CBC)
11+
>>> c1 = camellia.CamelliaCipher(key=b'16 byte long key', IV=b'16 byte iv. abcd', mode=camellia.MODE_CBC)
1212
>>> encrypted = c1.encrypt(plain)
13-
>>> c2 = camellia.CamelliaCipher(key=b'16 byte long key', IV=b'16 byte iv. xxxx', mode=camellia.MODE_CBC)
13+
>>> c2 = camellia.CamelliaCipher(key=b'16 byte long key', IV=b'16 byte iv. abcd', mode=camellia.MODE_CBC)
1414
>>> c2.decrypt(encrypted)
1515
b'This is a text. '
1616
@@ -20,9 +20,9 @@ Features
2020
========
2121

2222
Because it's build direct on top of the reference implementation, the python-camellia library provides direct
23-
access to extreme low-level functions like *Camellia-Ekeygen* but also provides a nearly PEP-compliant
23+
access to extreme low-level functions like *Camellia-Ekeygen* but also provides a nearly PEP-272-compliant
2424
cryptographic interface. This semi low-level interface supports encryption (and decryption) in ECB,
25-
CBC and CTR mode.
25+
CBC, CFB, OFB and CTR modes of operation.
2626

2727
Installation
2828
============
@@ -31,21 +31,9 @@ Install with pip:
3131

3232
.. code:: shell
3333
34-
$ [sudo] pip install python-camellia
34+
$ pip install python-camellia
3535
3636
37-
After installation the non-python C extension must be compiled,
38-
gcc or compitable is required:
39-
40-
.. code:: shell
41-
42-
$ [sudo] python -m camellia
43-
44-
To specify another compiler define the "CC" variable:
45-
46-
.. code:: shell
47-
48-
$ [sudo] CC=clang python -m camellia
4937
5038
Licenses
5139
========
@@ -73,7 +61,7 @@ Licenses
7361
THE SOFTWARE.
7462
7563
76-
This software uses the official camellia engine. Tey 2-clause-BSD licensed.
64+
This software uses the official camellia engine which is 2-clause-BSD licensed:
7765

7866
.. code::
7967
@@ -105,13 +93,13 @@ This software uses the official camellia engine. Tey 2-clause-BSD licensed.
10593
Other things
10694
============
10795

108-
This software contains compiled encryption algorithms which is restricted by law in some countries.
96+
This software contains encryption algorithms which is restricted by law in some countries.
10997

11098

11199
Changelog
112100
=========
113101

114-
For Version 1.0:
102+
Version 1.0:
115103
- The "normal" camellia version is used instead of the mini or reference version.
116104
- Camellia is now loaded using CFFI. This improves speed and avoids shipped DLLs. It's better than the self-made-on-first-use compilation.
117-
- Supports CTR mode
105+
- Supports all standart modes of operation (ECB, CBC, CFB, OFB, CTR)

0 commit comments

Comments
 (0)