Skip to content

Commit aaed103

Browse files
committed
UPDATE: badge and link to decryption example in README
1 parent 6c5ca0d commit aaed103

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# MaxMind for Resolve.rs [<img alt="Resolve.rs Logo" src="https://resolve.rs/favicon.svg" height="96" align="right"/>](https://resolve.rs/)
22

3+
[![Release](https://github.com/redirect2me/geodb-maxmind/actions/workflows/release.yaml/badge.svg)](https://github.com/redirect2me/geodb-maxmind/actions/workflows/release.yaml)
4+
35
The MaxMind "Lite" databases are free to use, but you cannot redistribute them, and cannot (reliably) download them every time a server starts. To get a server to start without hitting MaxMind directly, I use an encrypted version that automatically updates once a week.
46

57
## Using
@@ -10,7 +12,7 @@ This is just for [resolve.rs](https://resolve.rs), but you can do the same thing
1012
* `MAXMIND_ACCOUNT_ID` - also from MaxMind
1113
* `MMDB_ENCRYPTION_KEY` - generate a 32-byte (64 hex digits) encryption key
1214

13-
You will use the `MMDB_ENCRYPTION_KEY` when decrypting the database files on your server.
15+
You will use the `MMDB_ENCRYPTION_KEY` when decrypting the database files on your server. See the [code in resolve.rs](https://github.com/redirect2me/resolvers/blob/main/src/data/maxmindData.ts#L36) for an example of how to do this in TypeScript.
1416

1517
## License
1618

0 commit comments

Comments
 (0)