diff --git a/README.md b/README.md index 88f656d..3925abf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # ipaddrgen 👩‍💻 -### the funny ip address generator + +## the funny ip address generator a small cli program written in go that generates random ip addresses and "does things" to them. @@ -9,11 +10,11 @@ a small cli program written in go that generates random ip addresses and "does t *legal disclaimer: no this isn't a "hacking" tool, it's a goofy piece of software that spits text out onto the screen and nothing more. I wholeheartedly encourage that this software be used in le funny hacking montage.* -# screenies 📸 +## screenies 📸 ![ipaddrgen in action](screenshots/v1term.png) -# use it! ✨ +## use it! ✨ [download](https://github.com/mellodoot/ipaddrgen/releases/latest) whichever version is compatible with your OS (if such a version isn't listed, I'm so sorry!), then run it via your terminal! @@ -21,14 +22,14 @@ i.e. `./ipaddrgen-PLATFORM-ARCH` for help with command-line arguments (for some fun customisation), try `./ipaddrgen -h`! -# build it! 📀 +## build it! 📀 -### requirements: +### requirements - [go](https://go.dev/) (currently using 1.17.6) - that's about it -### how: +### how windows: `go build -o ./bin/ipaddrgen.exe ./src`