Merge branch 'develop/xml' into xml

.gitignore

@@ -1,6 +1,5 @@
-.DS_Store
-.classpath
-.project
-.settings
-bin
-build
+target/
+
+.*
+!.gitignore
+!.travis.yml

README.md

@@ -0,0 +1,41 @@
+# JAvroPhonetic v1.2
+
+A Java implementation of Avro Phonetic
+
+Website: [OmicronLab.com](http://omicronlab.com/)
+
+## Compilation
+
+We use maven to handle our dependencies.
+
+* Install [Maven 3](http://maven.apache.org/download.html)
+* Check out this repo and: `mvn clean install`
+
+## Usage
+### With Built-in XML Loader & XML Rules
+    PhoneticParser avro = PhoneticParser.getInstance();    
+    avro.setLoader(new PhoneticXmlLoader());
+	String bangla = avro.parse("ami banglay gan gai");
+	System.out.println(bangla); // আমি বাংলায় গান গাই
+
+### With Built-in XML Loader & Custom XML Rules File
+    PhoneticParser parser = PhoneticParser.getInstance();
+    String customXmlRulesFile = "/path/to/the/rules.xml";
+    PhoneticLoader loader = new PhoneticXmlLoader(customXmlRulesFile);
+    parser.setLoader(loader);
+	String output = parser.parse("content to parse");
+
+### With Custom Loader
+	public class CustomLoader implements PhoneticLoader {
+		…
+		public Data getData() throws Exception {
+			…
+		}
+		…
+	}
+
+---
+
+    PhoneticParser parser = PhoneticParser.getInstance();
+    parser.setLoader(new CustomLoader());
+	String output = parser.parse("content to parse");

pom.xml

@@ -0,0 +1,39 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.omicronlab.avro</groupId>
+  <artifactId>avro-phonetic</artifactId>
+  <version>1.2</version>
+  <packaging>jar</packaging>
+
+  <name>JAvroPhonetic</name>
+  <url>http://omicronlab.com/</url>
+  <description>A Java implementation of Avro Phonetic</description>
+
+  <scm>
+    <developerConnection>scm:git:[email protected]:torifat/JAvroPhonetic.git</developerConnection>
+    <connection>scm:git:git://github.com/torifat/JAvroPhonetic.git</connection>
+    <url>https://github.com/torifat/JAvroPhonetic/tree/xml</url>
+  </scm>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.apache.commons</groupId>
+      <artifactId>commons-digester3</artifactId>
+      <version>3.2</version>
+      <scope>compile</scope>
+    </dependency>
+    <!-- testing -->
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.10</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+</project>