refactor: rename the project to word_otter

Cargo.toml

@@ -1,14 +1,18 @@
 [package]
-name = "password_generator"
-version = "0.1.0"
+name = "word_otter"
+version = "0.1.1"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[features]
+force-cross = ["gmp-mpfr-sys/force-cross"]
+
 [dependencies]
 clap = { version = "4.1.8", features = ["derive"] }
 color-eyre = "0.6.2"
 rand = "0.8.5"
 regex = "1.10.4"
 rug = "1.19.2"
 unicode-normalization = "0.1.22"
+gmp-mpfr-sys = "~1.6"

README

@@ -0,0 +1,66 @@
+# WordOtter
+
+WordOtter is a secure and user-friendly password generator that creates strong passphrases using a list of words. The project aims to provide an easy-to-use tool for generating memorable yet secure passwords.
+
+## Why "WordOtter"?
+
+The name "WordOtter" was chosen because otters are playful and intelligent animals, which reflects the nature of this password generator. Otters are known for their dexterity and problem-solving skills, symbolizing the efficiency and effectiveness of WordOtter in creating secure passphrases. Additionally, the playful aspect of otters makes the tool seem approachable and fun to use.
+
+## Features
+
+- Generates strong passphrases using a list of words
+- User-friendly and approachable interface
+- Secure and robust password generation
+- Customizable options for passphrase length and complexity
+
+## Installation
+
+To install WordOtter, you need to have Rust and Cargo installed on your system. You can install Rust and Cargo by following the instructions at [rust-lang.org](https://www.rust-lang.org/).
+
+Clone the repository and navigate to the project directory:
+
+```sh
+git clone https://github.com/Schuwi/word_otter.git
+cd word_otter
+```
+
+Build the project using Cargo:
+
+```sh
+cargo build --release
+```
+
+## Usage
+
+After building the project, you can show the help message with the following command:
+
+```sh
+cargo run --release -- -h
+```
+
+You need to provide a word list as a file. By default the program will look for `wordliste.txt` in the current directory.\
+The format is quite simple. It's just a list of words separated by line breaks.
+
+You can customize the passphrase generation by providing additional options. For example, to generate a passphrase with a specific number of words:
+
+```sh
+cargo run --release -- 5
+```
+
+## Dependencies
+
+WordOtter uses the following dependencies:
+
+- `clap` for command-line argument parsing
+- `color-eyre` for enhanced error reporting
+- `rand` for random number generation
+- `regex` for regular expression support
+- `rug` for arbitrary precision arithmetic
+- `unicode-normalization` for Unicode normalization
+
+## Contributing
+Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or improvements.
+
+---
+
+Enjoy using WordOtter and stay secure!