Add README.md

1 files changed, 16 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..893b590
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# nfsp-dnslink
+
+Automated setting of a [DNSLink](https://dnslink.io) TXT record to
+your [NearlyFreeSpeech](https://www.nearlyfreespeech.net/) domain name.
+Useful for static website publishing or mirroring on IPFS, specifically
+Git post-receive hook.
+
+# How to use it
+
+Fill out the `$Username`, `$Apikey` and `$AccountId` variable
+in the script with values from your account.
+Then, general usage is as follows:
+
+```bash
+nfsp_dnslink [IPFS CID] [DOMAIN] (optional subdomain)
+```