summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b50a757
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Data migration plugin
+
+Migrates user articles using a neutral format (JSON in a ZIP archive). Can be used
+to transfer articles between different database types (i.e. MySQL to PostgreSQL).
+
+## Installation
+
+1. Git clone to ``/plugins.local/data_migration``
+2. Enable plugin in ``PLUGINS`` directive of ``config.php``
+3. Plugin is invoked using command line: ``php ./update.php --help``