Document the current state of locopy

1 files changed, 17 insertions, 1 deletions

diff --git a/README.md b/README.md
index eb6a296..33592b1 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,8 @@ The repository contains a collection of random scripts and short programs.
 3. [cross\_toolchain.rb](#cross_toolchainrb)
 4. [rename.rb](#renamerb)
 5. [pg\_jekyll.rb](#pg_jekyllrb)
-6. [tea-cleaner](#tea-cleaner)
+6. [locopy](#locopy)
+7. [tea-cleaner](#tea-cleaner)
 
 ## 7digital.rb
 
@@ -66,6 +67,21 @@ environment variables `USER` and `DBNAME` to be present in the environment.
 Pages are written into the `posts/` directory. A column named `slug` is used
 for the name with `.html` extension.
 
+## locopy
+
+locopy updates Wordpress `siteurl` and `home` options and sets them to
+http://localhost:8083, so that the Wordpress instance can run locally.
+
+locopy reads Wordpress database configuration from the `wp-config.php` that
+it should be able to find. Invokation example:
+
+```sh
+./locopy/locopy.rb wordpress --root /path/to/wordpress --dump=
+```
+
+The `--dump` option isn't currently used but should be present on the command
+line.
+
 ## tea-cleaner
 
 `tea-cleaner` tries to detect spam accounts on a gitea instance and can remove