Skip to content

Commit

Permalink
Merge pull request #43 from kushaldas/changelog_update
Browse files Browse the repository at this point in the history
Changelog update
  • Loading branch information
kushaldas authored Oct 22, 2020
2 parents 60f4ad0 + 58c71d6 commit 9cde3d3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,12 @@ python3 -m pip install requirements-dev.txt
maturin develop
```

## Usage example
## Introduction

```Python
>>> import johnnycanencrypt as jce
>>> j = jce.Johnny("public.asc")
>>> data = j.encrypt_bytes(b"kushal \xf0\x9f\x90\x8d")
>>> js = jce.Johnny("secret.asc")
>>> result = js.decrypt_bytes(data, "mysecretpassword")
>>> print(result.decode("utf-8"))
kushal 🐍

```
Please read the [Introduction](https://johnnycanencrypt.readthedocs.io/en/latest/introduction.html) documentation.

## API documentation

Please go through the [full API documentation](https://johnnycanencrypt.readthedocs.io/en/latest/) for detailed descriptions.
Please go through the [full API documentation](https://johnnycanencrypt.readthedocs.io/en/latest/api.html) for detailed descriptions.

## LICENSE: GPLv3+
6 changes: 5 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Changlelog

## unreleased
## 2020-10-22

### Added

- `encrypt_bytes_to_file` can encrypt data for multiple recipients and saves to a file.
- Function signature to the `create_newkey` function.
- Uses sequoia-pgp 0.20.0 as dependency #31
- Can not use sha1 based keys with this library #29
- SQLite3 based KeyStore `jce.db`
- Python ENUMs key type and cipher type #33

### Fixed

Expand Down

0 comments on commit 9cde3d3

Please sign in to comment.