* Finalizing for full release and out of alpha

* Added update check
* Removed some debug checks

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "haveibeenpwned"
-version = "0.5.0-alpha"
+version = "0.5.0"
 edition = "2021"
 license = "AGPL-3.0-only"
 authors = ["CKingX"]
@@ -31,7 +31,9 @@ serde = "1.0.*"
 bincode = "1.3.3"
 directories = "2.0.2"
 bitvec = {version = "1.0.0", features = ["serde"]}
+update-informer = "0.5.0"
 
 [profile.release]
 overflow-checks = true
-lto = "thin"
+lto = "thin"
+strip = true

README.md

@@ -1,13 +1,58 @@
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FCKingX%2Fhaveibeenpwned.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FCKingX%2Fhaveibeenpwned?ref=badge_shield)
+
 # haveibeenpwned
 
 haveibeenpwned is a command-line application that uses [HaveIBeenPwned](https://haveibeenpwned.com/) service and can create and use Binary Fuse filter (which is smaller than Bloom filter or Cuckoo filter for the same false positive ratio) for efficient query at cost of false positives. This is still WIP.
 
-## Roadmap
-- [x] Interactively check compromised password using HIBP API (requires internet)
-- [x] Download password file using HaveIBeenPwned queries. This can be more up to date than downloading passwords directly from HaveIBeenPwned website. According to Troy Hunt, passwords from ingestions are not included since a password version release in the download version. However, querying the password does contain the ingested passwords
-- [x] Interactively check compromised password using filter
-- [x] Create filter (of 3 sizes) that allows you to query offline while consuming a fraction of the space. Does require existing downloaded password file (either from website or by using this tool) to create. However, downloadable filter files will eventually be provided.
-- [ ] Check list of passwords in a file (using a filter) to see how many are compromised
+## Features
+- Interactively check compromised password using HIBP API (requires internet) with `haveibeenpwed interactive-online`
+- Download password file using HaveIBeenPwned queries. This can be more up to date than downloading passwords directly from HaveIBeenPwned website. According to Troy Hunt, passwords from ingestions are not included since a password version release in the download version. However, querying the password does contain the ingested passwords. In practice, this contained 3 more passwords than version 8 as of June 7 (847,223,405 vs Version 8's 847,223,402). You can download with `haveibeenpwned downloader [path to output file]`
+- Downloads can be resumed if given the same argument
+- Can interactively check compromised password using filter with `haveibeenpwned interactive-filter [path to filter file]`
+- Can create filter (of 3 sizes) that allows you to query offline while consuming a fraction of the space. Does require existing downloaded password file (either from website or by using this tool) to create with. Filter can be created with `haveibeenpwned create-filter [path to password file] [output path for filter file]`
+- Check list of passwords in a file (using a filter) to see how many are compromised with `haveibeenpwned file-check [path to file with passwords to test] [path to filter]` (with optional -p command to print compromised passwords from the file)
 
 ## Compatibility
-As haveibeenpwned is still in alpha, the design of the filter is not final.  Therefore, filter file compatibility will **not** be maintained between versions until haveibeenpwned is no longer an alpha version. Filter created by version 0.4.0-alpha is not compatible with 0.5.0-alpha (for example).
+As haveibeenpwned was in alpha, the design of the filter wasis not final at the time. Therefore, filter file compatibility was not maintained between versions until now. Filter created by version 0.4.0-alpha is not compatible with 0.5.0 (and version 0.5.0 has smaller filters than version 0.4.0). However, compatibility from v0.5.0 onwards (current version) will be maintained.
+
+## Install
+haveibeenpwned can be downloaded from [Releases](https://github.com/CKingX/haveibeenpwned/releases) page for Ubuntu .deb package for 18.04 and later, generic linux executable for 64-bit Intel systems (You may need to run `chmod +x <path to binary>`), and Windows releases. If you have rustup installed (see Build Guide), you can install by running:
+```
+cargo intall haveibeenpwned
+```
+
+Currently, macOS builds are not provided as I do not have a Mac. I will also work on creating a flatpak version of haveibeenpwned
+
+## Upgrade Instructions
+If you use the deb file on Ubuntu, uninstall the deb package with:
+```
+sudo apt remove haveibeenpwned
+```
+Finally, install with the newer deb file.
+
+For Windows, just replace the older haveibeenpwned.exe with the newer version.
+
+If you used the haveibeenpwned linux binary, just replace it with newer one (you may need to run `chmodm +x <path to haveibeenpwned>` again)
+
+## Build Guide
+We can use cargo to build haveibeenpwned. We first need to install rustup and build tools (instructions for those can be found [here](https://www.rust-lang.org/tools/install)). Then, we can build with:
+```
+git clone https://github.com/CKingX/haveibeenpwned.git
+cd ./haveibeenpwned
+cargo install --path ./
+```
+Now you can run by typing haveibeenpwned in terminal. Upgrading can be done with cargo install command again. If you would just like to build the binary, you can build the debug binary with:
+```
+cargo build
+```
+Release binary can be built with:
+```
+cargo build --release
+```
+
+The output of the build command will be in ./target/{debug/release}/haveibeenpwned
+
+## License
+haveibeenpwned is licensed as AGPL 3.0. However, there will eventually be an MPL library that can use a filter to check passwords in other programs.
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FCKingX%2Fhaveibeenpwned.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FCKingX%2Fhaveibeenpwned?ref=badge_large)

src/config.rs

@@ -27,10 +27,10 @@ impl Config {
             .write(true)
             .create(true)
             .open(config_file)
-            .unwrap();
+            .expect("Unable to open config file");
 
         let mut file_contents = Vec::new();
-        file.read_to_end(&mut file_contents).unwrap();
+        file.read_to_end(&mut file_contents).expect("Unable to read config file");
         let result: Result<Self, _> = bincode::deserialize(&file_contents);
         match result {
             Ok(result) => result,
@@ -47,9 +47,9 @@ impl Config {
             .truncate(true)
             .create(true)
             .open(config_file)
-            .unwrap();
-        let serialized = bincode::serialize(&self).unwrap();
-        file.write_all(&serialized).unwrap();
+            .expect("Unable to open config file");
+        let serialized = bincode::serialize(&self).expect("Unable to create configuration");
+        file.write_all(&serialized).expect("Unable to write configuration file");
     }
 
     fn get_config_file() -> PathBuf {

src/downloader.rs

@@ -149,6 +149,7 @@ pub fn downloader(output: OsString) {
                     });
                     config.store();
                     error::download_error(n);
+                    eprintln!("You can resume the download by running with the same command");
                     break;
                 }
             }

src/main.rs

@@ -10,10 +10,18 @@ mod interactive_online;
 mod password;
 
 use arguments::*;
+use update_informer::{registry, Check};
 
 fn main() {
     let args = handle_arguments();
 
+    let name = env!("CARGO_PKG_NAME");
+    let version = env!("CARGO_PKG_VERSION");
+    let informer = update_informer::new(registry::Crates, name, version);
+    if let Ok(Some(version)) = informer.check_version() {
+        println!("New version is available: {} at https://github.com/CKingX/haveibeenpwned", version);
+    }
+
     match args.command {
         Commands::InteractiveFile { file } => interactive_file::interactive_file(file),
         Commands::InteractiveOnline => interactive_online::interactive(),

src/password.rs

@@ -81,14 +81,7 @@ pub fn download_range(agent: &ureq::Agent, range: u64) -> Result<String, ServerE
     let request = agent
         .get(&format!("https://api.pwnedpasswords.com/range/{range}"))
         .set("Add-Padding", "true")
-        .call();
-
-    if let Err(error) = request {
-        _ = dbg!(error);
-        return Err(ServerError);
-    }
-    let request = request
-        .unwrap()
+        .call()?
         .into_string()?
         .lines()
         .filter(strip_padding)