Skip to content

Commit e58514c

Browse files
committed
Improved documentation
1 parent f448b1f commit e58514c

4 files changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
This library extends the native [`codecs`](https://docs.python.org/3/library/codecs.html) library (namely for adding new custom encodings and character mappings) and provides a myriad of new encodings (static or parametrized, like `rot` or `xor`), hence its named combining *CODecs EXTension*.
1313

14+
15+
1416
## Setup
1517

1618
```sh
@@ -19,6 +21,12 @@ $ pip install codext
1921

2022
**Note**: Some encodings are available in Python 3 only.
2123

24+
## Demonstrations
25+
26+
<p align="center"><img src="https://raw.githubusercontent.com/dhondta/python-codext/master/docs/demos/using-codext.gif" alt="Using CodExt from the command line"></p>
27+
<p align="center"><img src="https://raw.githubusercontent.com/dhondta/python-codext/master/docs/demos/using-bases.gif" alt="Using base tools from the command line"></p>
28+
<p align="center"><img src="https://raw.githubusercontent.com/dhondta/python-codext/master/docs/demos/using-debase.gif" alt="Using the debase command line tool"></p>
29+
2230
## Usage (CLI tool)
2331

2432
```sh

docs/demos/using-bases.gif

112 KB
Loading

docs/demos/using-codext.gif

3.17 MB
Loading

docs/demos/using-debase.gif

398 KB
Loading

0 commit comments

Comments
 (0)