Initial commit.v0.1

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100755
index 0000000..b793b15
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# LrMediaWiki
+
+**LrMediaWiki** is a plugin for Adobe Photoshop Lightroom that allows users
+to upload images to Wikimedia Commons or any other MediaWiki installation
+directly from Lightroom.
+
+## Usage information
+
+Usage information can be found on the page [Commons:LrMediaWiki][comlrmw] on
+Wikimedia Commons.
+
+## Developer information
+
+LrMediaWiki is developed in Lua using the [Lightroom SDK][lrsdk].  It is
+released under the MIT/X11 license.  LrMediaWiki should work with all 
+Lightroom 5 installations both on Windows and on Mac OS.
+
+### Code structure
+
+The plugin code is located in the `mediawiki.lrdevplugin` directory.
+`Info.lua` defines the plugin metadata to be read by Lightroom.
+`MediaWikiExportServiceProvider.lua` defines the user interfaces and passes
+all necessary information to `MediaWikiInterface.lua`.  This file evaluates
+the user input and prepares the file description and the file itself for the
+MediaWiki upload.  The upload is done in `MediaWikiApi.lua`.
+
+### Create release
+
+To create a new release,
+ - copy the `mediawiki.lrdevplugin` folder and rename it to
+   `mediawiki.lrplugin`,
+ - copy the `CREDITS.txt`, `LICENSE.txt` and `README.md` files in the new
+   folder,
+ - update the version information in `Info.lua` (if necessary) and finally
+ - create an archive of the `mediawiki.lrplugin` folder.
+This archive may now be released.
+
+[comlrmw]: https://commons.wikimedia.org/wiki/Commons:LrMediaWiki
+[lrsdk]: http://www.adobe.com/devnet/photoshoplightroom.html