improve readme

Author: bwireman

.gitignore

@@ -2,7 +2,7 @@
 *.ez
 /build
 erl_crash.dump
-/.go-over
+.go-over/
 node_modules/
 .vscode
 key._

README.md

@@ -1,22 +1,38 @@
-# go_over
+# 🕵️‍♂️ go_over
 
 [![Package Version](https://img.shields.io/hexpm/v/go_over)](https://hex.pm/packages/go_over)
 [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/go_over/)
 
+A tool to check for Erlang & Elixir dependency advisories as well as retired hex packages, to make sure you gleam projects really sparkle! ✨
+
+🚨 _**NOTE**_: security advisories are _NOT_ currently monitored for gleam dependencies. The language, while excellent, is far too new and niche
+
+# Install
+
 ```sh
 gleam add go_over
 ```
-```gleam
-import go_over
 
-pub fn main() {
-  // TODO: An example of the project in use
-}
+and add `.go-over/` to your `.gitignore`
+
+# Usage
+
+```sh
+gleam run -m go_over
 ```
 
-Further documentation can be found at <https://hexdocs.pm/go_over>.
+## Caching
+
+- Security advisory data is cached for six hours
+- hex.pm retired package data is cached for one hour
+
+# Other Art
+
+- As I'm sure is no surprise this tool is inspired by (and all around worse than) [mirego/mix_audit](https://github.com/mirego/mix_audit). Please check it out!
+- It also draws inspiration from [mix hex.audit](https://hexdocs.pm/hex/Mix.Tasks.Hex.Audit.html)
+
+# License
 
-UNDER CONSTRUCTION!!
-uses https://github.com/mirego/elixir-security-advisories which is licensed with `BSD-3-Clause license` and uses data inside the packages directory is pulled from GitHub API, it is licensed under the terms of the CC-BY 4.0 open source license. See GitHub documentation for the full terms.
+This tool uses [mirego/elixir-security-advisories](https://github.com/mirego/elixir-security-advisories) which is it self licensed with `BSD-3-Clause license` and `CC-BY 4.0 open source license`. See their [#license section](https://github.com/mirego/elixir-security-advisories?tab=readme-ov-file#license)
 
-Code original to this repo is Licensed under MIT
+Code original to this repo is Licensed under MIT

src/go_over.gleam

@@ -45,7 +45,7 @@ pub fn main() {
   case list.append(retired_packages, vulnerable_packages) {
     [] ->
       shellout.style(
-        "✅ All good! ✨",
+        "✅ All good! ✨\n\n",
         with: shellout.color(["brightgreen"]),
         custom: [],
       )
@@ -67,6 +67,8 @@ pub fn main() {
       })
       |> string.join("\n-----------------------------------------------\n")
       |> io.print
+
+      shellout.exit(1)
     }
   }
 }