From faa76023b0649fc4c85397b0824d5944f79d3a63 Mon Sep 17 00:00:00 2001
From: Mike Ryan <mikeryan@virtuoso-performance.com>
Date: Wed, 20 Apr 2016 09:36:57 -0500
Subject: [PATCH] Issue #2709535 by mikeryan: Add a README

---
 README.txt | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.txt

diff --git a/README.txt b/README.txt
new file mode 100644
index 00000000..8e46d4ce
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,34 @@
+The migrate_plus module extends the core migration system with API enhancements
+and additional functionality, as well as providing practical examples.
+
+Extensions to base API
+======================
+* A Migration configuration entity is provided, enabling persistance of dynamic
+migration configuration.
+* A ConfigEntityDiscovery class is implemented which enables plugin configuration
+to be based on configuration entities. This is fully general - it can be used
+for any configuration entity type, not just migrations.
+* A MigrationConfigEntityPluginManager class and corresponding
+plugin.manager.config_entity_migration service is provided, to enable discovery
+and instantiation of migration plugins based on the Migration configuration
+entity.
+* A MigrationGroup configuration entity is provided, which enables migrations to
+be organized in groups, and to maintain shared configuration in one place.
+* A MigrateEvents::PREPARE_ROW event is provided to dispatch hook_prepare_row()
+invocations as events.
+* A SourcePluginExtension class is provided, enabling one to define fields and
+IDs for a source plugin via configuration rather than requiring PHP code.
+
+Plugins
+=======
+* A Url source plugin is provided, implementing a common structure for
+file-based data providers.
+* XML and JSON fetchers and parsers for the Url source plugin are provided.
+
+Examples
+========
+* The migrate_example submodule provides a fully functional and runnable
+example migration scenario demonstrating the basic concepts and most common
+techniques for SQL-based migrations.
+* The migrate_example_advanced submodule provides examples of migration from
+different kinds of sources, as well as less common techniques.
-- 
GitLab