Skip to content

Commit

Permalink
update readme and bump version again
Browse files Browse the repository at this point in the history
  • Loading branch information
callumjamesfortune committed Apr 23, 2024
1 parent c14ce33 commit 7bf9520
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "rust-miller-rabin"
version = "0.1.1"
version = "0.1.2"
edition = "2018"
description = "A Rust implementation of the Miller-Rabin primality test"
license = "MIT"
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# <img src="https://github.com/callum-fortune/rust-miller-rabin/assets/63158857/19ebacb0-75c5-4a59-9549-590513dec5e9" width="100">
# 🚀 Rust Miller-Rabin with bigInt capability
A complete Rust implementation of the Miller Rabin primality test algorithm, based heavily on (https://github.com/jsanders/rust-rsa).
A complete Rust implementation of the Miller Rabin primality test algorithm. View on github: https://github.com/callum-fortune/rust-miller-rabin

### Notes

- The Miller Rabin algorithm, whilst incredibly accurate has been known to produce false positives in some cases. This is because the algorithm is officially classed as a probabilistic primality test. Proceed to use this project with that knowledge. Read more here...

https://core.ac.uk/download/pdf/197479038.pdf

- The official github repo for this project is here...
- The project is based heavily on this implementation...

https://github.com/callum-fortune/rust-miller-rabin
https://github.com/jsanders/rust-rsa

- I am yet to be made aware of the higher limit of this project, I have tested the code with prime numbers more than 300 characters in length and as little as one, without fail.
- I created this project on my journey to implenting a basic Rust RSA implementation. This is a common use case for the Miller-Rabin test and there is a good chance that you are in the same process. Be warned that any implementations of your own that use this code are done at your own risk.
Expand Down

0 comments on commit 7bf9520

Please sign in to comment.