Browse Source

Edited readme

Signed-off-by: gryffyn <me@neveris.one>
main
gryffyn 3 weeks ago
parent
commit
662366d4b8
Signed by: gryffyn GPG Key ID: 6948DD6514D02BEF
  1. 12
      README.md

12
README.md

@ -28,7 +28,7 @@ $ bat -print=b example.tld/ip
As JSON:
```
$ curl -H 'Accept: application/json' ifconfig.co # or curl example.tld/json
$ curl -H 'Accept: application/json' example.tld # or curl example.tld/json
{
"ip": "127.0.0.1",
"ip_decimal": 2130706433,
@ -62,13 +62,13 @@ between IPv4 and IPv6 lookup.
## Building
Compiling requires the [Golang compiler](https://golang.org/) to be installed.
This package can be installed with `go get`:
You will no doubt want to customize the html, so the best way to build this is to clone the repo, edit the html, and build the binary.
`go get github.com/gryffyn/ipinfo/...`
```
git clone https://github.com/gryffyn/ipinfo
```
For more information on building a Go project, see the [official Go
documentation](https://golang.org/doc/code.html).
Edit the files in `http/html`, then run `make install`, or `cd cmd/ipinfo && go build`.
### Usage

Loading…
Cancel
Save