Merge pull request #8 from Splode/docs/readme-enhancements

docs: enhance README, usage text

Author: Splode

README.md

@@ -6,6 +6,27 @@ Generate random, human-friendly names, like `determined-pancake` or `sinister di
 
 fname isn't meant to provide a secure, globally unique identifier, but with over 500 billion possible combinations, it's good enough for most non-critical use cases.
 
+## Table of Contents
+
+- [fname](#fname)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+    - [Download](#download)
+    - [Go](#go)
+    - [Source](#source)
+  - [Usage](#usage)
+    - [CLI](#cli)
+    - [Library](#library)
+      - [Install](#install)
+      - [Basic Usage](#basic-usage)
+      - [Customization](#customization)
+  - [Disclaimers](#disclaimers)
+  - [Contributing](#contributing)
+    - [Reporting Issues](#reporting-issues)
+    - [Suggesting Improvements](#suggesting-improvements)
+  - [License](#license)
+  - [Related Projects](#related-projects)
+
 ## Installation
 
 ### Download
@@ -65,6 +86,16 @@ spellbinding-project-presented-fully
 
 Note: the minimum phrase size is 2 (default), and the maximum is 4.
 
+Generate a name phrase with a specific casing:
+
+```sh
+$ fname --casing upper
+TRAGIC-MOUNTAIN
+
+$ fname --casing title
+Whimsical-Party
+```
+
 Specify the seed for generating names:
 
 ```sh
@@ -129,6 +160,28 @@ fname is not cryptographically secure, and should not be used for anything that
 
 fname's dictionary is curated to exclude words that are offensive, or could be considered offensive, either alone or when generated in a phrase. Nevertheless, all cases are not and cannot be covered. If you find a word that you think should be removed, please [open an issue](https://github.com/Splode/fname/issues).
 
+## Contributing
+
+We welcome contributions to the fname project! Whether it's reporting bugs, suggesting improvements, or submitting new features, your input is valuable to us. Here's how you can get started:
+
+1. Fork the repository on GitHub.
+2. Clone your fork and create a new branch for your changes.
+3. Make your changes and commit them to your branch.
+4. Create a pull request, and provide a clear description of your changes.
+
+Before submitting a pull request, please make sure your changes are well-tested and adhere to the code style used throughout the project. If you are unsure how to proceed or need help, feel free to open an issue or ask a question in the [discussions](https://github.com/Splode/fname/discussions) section.
+
+### Reporting Issues
+
+If you encounter a bug or any issue, please [open an issue](https://github.com/Splode/fname/issues) on GitHub. When reporting a bug, try to include as much information as possible, such as the steps to reproduce the issue, the expected behavior, and the actual behavior. This will help us diagnose and fix the issue more efficiently.
+
+### Suggesting Improvements
+
+We are always looking for ways to improve fname. If you have a suggestion for a new feature or an enhancement to an existing feature, please [open an issue](https://github.com/Splode/fname/issues) or start a discussion in the [discussions](https://github.com/Splode/fname/discussions) section. Be sure to explain your idea in detail, and if possible, provide examples or use cases.
+
+Thank you for your interest in contributing to fname!
+
+
 
 ## License
 

cmd/fname/fname.go

@@ -53,10 +53,10 @@ func main() {
 		// TODO: add option to use custom dictionary
 	)
 
-	pflag.StringVarP(&casing, "casing", "c", casing, "case of generated names: lower, upper, or title")
-	pflag.StringVarP(&delimiter, "delimiter", "d", delimiter, "delimiter to use between words")
-	pflag.IntVarP(&quantity, "quantity", "q", quantity, "number of name phrases to generate")
-	pflag.UintVarP(&size, "size", "z", size, "number of words per phrase (minimum 2, maximum 4)")
+	pflag.StringVarP(&casing, "casing", "c", casing, "set the casing of the generated name <title|upper|lower>")
+	pflag.StringVarP(&delimiter, "delimiter", "d", delimiter, "set the delimiter used to join words")
+	pflag.IntVarP(&quantity, "quantity", "q", quantity, "set the number of names to generate")
+	pflag.UintVarP(&size, "size", "z", size, "set the number of words in the generated name (minimum 2, maximum 4)")
 	pflag.Int64VarP(&seed, "seed", "s", seed, "random generator seed")
 	pflag.BoolVarP(&help, "help", "h", help, "show fname usage")
 	pflag.BoolVarP(&ver, "version", "v", ver, "show fname version")