diff --git a/README.md b/README.md index 8ab3fc4..de6d90a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ -# computerinfo -A simple application to display computer info such as the computer name +# Computer Info + +A simple application to display the local computer name and IP addresses + +## Building + +Built with fyne package + +``` +fyne package +``` + +## Usage + +The latest windows executable is attached to the [releases](https://github.com/ryanehamil/computerinfo/releases) + + +## Contributing + +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +## License +[GNU GPL v3](https://choosealicense.com/licenses/gpl-3.0/) \ No newline at end of file