Added a license & readme

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Malcolm Roberts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,41 @@
-[![Build Status](https://drone.mroberts.dev/api/badges/mickey/usergen/status.svg)](https://drone.mroberts.dev/mickey/usergen)
+[![Build Status](https://drone.mroberts.dev/api/badges/mickey/usergen/status.svg)](https://drone.mroberts.dev/mickey/usergen)
+
+# Usergen - Random Username Generator
+
+## Overview
+
+`usergen` is a simple yet powerful utility written in Go, designed to generate random usernames by combining verbs with nouns in a `verb-noun` format. It's perfect for creating unique and memorable usernames for a variety of applications. The utility is flexible, allowing users to specify the number of usernames to generate and optionally copy the output directly to the clipboard.
+
+## Features
+
+- **Written in Go**: Fast and efficient execution.
+- **Customizable Output**: Control over the number of usernames generated.
+- **Clipboard Support**: Easy copying of generated usernames to the clipboard for immediate use.
+- **Cross-Platform Compatibility**: Supports OSX, Windows (tested on Windows 7 but should work on others), and Linux/Unix (requires 'xclip' or 'xsel').
+
+## Getting Started
+
+### Installation
+
+You can download the provided release for your OS on the [releases page](https://git.mroberts.dev/mickey/usergen/releases)
+
+### Usage
+
+Run usergen with the following command-line arguments:
+
+-n X to specify the number of usernames to generate (where X is the number of usernames).
+-c to copy the generated usernames to the clipboard.
+
+```bash
+usergen -n 1 -c
+```
+
+This will generate a random username and copy it to the clipboard
+
+### Development
+
+The repository includes a .devcontainer definition for easy development setup using Visual Studio Code's Dev Containers. This allows you to work with a consistent development environment.
+
+## License
+
+Distributed under the MIT License. See LICENSE file in the repository for more information.