Create README.md

hallowelt · Jul 16, 2021 · 686005a · 686005a
1 parent fa7d353
commit 686005a
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# MediaWiki XML library
+
+This library can be used to create XML that can be imported into MediaWiki.
+
+See also https://www.mediawiki.org/wiki/Manual:ImportDump.php
+
+## How to use
+
+```php
+$builder = new Builder();
+$builder->addRevision( "Some page title", "Some wiki text" );
+$builder->buildAndSave( "/path/to/ouput.xml" );
+```