Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dr8co committed Jun 27, 2024
1 parent 9c36916 commit 6e57ad9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ The process might be slow, and multithreading has been leveraged to speed up the
The [Serpent cipher](https://en.wikipedia.org/wiki/Serpent_(cipher))
is used for the first step because it is a
conservative and secure cipher with more rounds than [AES cipher](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard)
(32 rounds vs 14 rounds, hence a larger security margin) that is resistant to cryptanalysis.
(32 rounds vs. 14 rounds, hence a larger security margin) that is resistant to cryptanalysis.
The [counter mode (CTR)](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR))
is used for it because it is a fast and secure mode that is resistant to padding oracle attacks.
A non-deterministic random [nonce](https://en.wikipedia.org/wiki/Cryptographic_nonce)
Expand Down Expand Up @@ -358,6 +358,7 @@ or [LLVM Clang 18](https://clang.llvm.org/) (or newer) is required.
* [GCrypt](https://gnupg.org/software/libgcrypt/index.html) 1.10+
* [BLAKE3](https://github.com/BLAKE3-team/BLAKE3) 1.4+ (Fetched automatically by CMake, if not already installed)
* [Isocline](https://github.com/daanx/isocline) (Fetched automatically by CMake)
* [Mimalloc](https://github.com/microsoft/mimalloc) 2.17+ (Fetched automatically by CMake)

**Note:**\
This project utilizes the [C++20 Modules](https://en.cppreference.com/w/cpp/language/modules) feature,
Expand Down Expand Up @@ -429,6 +430,9 @@ You can then run the program from the build directory:
You can download a package for your platform from the
[releases page](https://github.com/dr8co/PrivacyShield/releases).

The packages expect the dependencies to be installed on the system,
except the ones that are fetched automatically by CMake (they are statically linked to the executable).

The package will contain the built executable, and you can install it using the package manager of your platform.

For the macOS package, you can simply drag the .dmg file to your Applications folder.
Expand Down Expand Up @@ -541,6 +545,10 @@ However, the feeling of empowered privacy protection is a strong possibility!

![""](./media/blank.svg)

[![Mimalloc](./media/mimalloc-logo.png)](https://github.com/microsoft/mimalloc)

![""](./media/blank.svg)

[![Isocline](./media/isocline.svg)](https://github.com/daanx/isocline)

## License
Expand Down
Binary file added media/mimalloc-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6e57ad9

Please sign in to comment.