From 8ed7b8d8946250d6917e83ba8bfd65ef7d006817 Mon Sep 17 00:00:00 2001
From: Miquel Lionel <lionel@les-miquelots.net>
Date: Mon, 17 Jan 2022 21:11:34 +0100
Subject: Add README.md

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

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)
+```
-- 
cgit v1.2.3-54-g00ecf