📝 Add README

README.md

@@ -0,0 +1,29 @@
+# http-go-status
+
+Inspired by [httpstatu.us](https://github.com/aaronpowell/httpstatus), but written in Go, and is almost as minimal as possible. Only a signle dependency, and less than 100 lines of code in a single file.
+
+## Installation
+
+```shell
+go install codeberg.org/danjones000/http-go-status@latest
+```
+
+## Usage
+
+```shell
+http-go-status
+```
+
+Then, make a request to your server. By default, it's running on port 8080, but you can set an environment variable, called PORT, to the port you prefer before running the command.
+
+To make your request from within a web browser (CORS is supported), you could do this from the JS console:
+
+```javascript
+let resp = await fetch("http://localhost:8080/451");
+console.log(resp.status); // 451
+console.log(resp.statusText); // Unavailable for Legal Reasons
+```
+
+## Deployment
+
+I'll leave this as an exercise for the reader.