diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7b893b1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# Activiti API Doclet
+
+This library provides a Javadoc Doclet for the generation of Activiti API documentation.  You can use it by defining a Javadoc plugin in your Activiti extension Maven JAR project.  That plugin should be configured to use this doclet.  See the snippet below.
+
+```xml
+<profile>
+	<id>apidocs</id>
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<version>3.4.1</version>
+				<executions>
+					<execution>
+						<id>generate-doclet</id>
+						<phase>generate-resources</phase>
+						<goals><goal>javadoc</goal></goals>
+						<configuration>
+							<doclet>com.inteligr8.activiti.doclet.ActivitiDoclet</doclet>
+							<docletArtifact>
+								<groupId>com.inteligr8.activiti</groupId>
+								<artifactId>activiti-api-doclet</artifactId>
+								<version>1.0.0</version>
+							</docletArtifact>
+							<useStandardDocletOptions>false</useStandardDocletOptions>
+							<destDir>destDir</destDir>
+							<additionalOptions>
+								<additionalOption>-d d</additionalOption>
+								<additionalOption>--flavor bitbucket</additionalOption>
+								<additionalOption>--title 'API Documentation'</additionalOption>
+								<additionalOption>--apiName '${project.name}</additionalOption>
+							</additionalOptions>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+		</plugins>
+	</build>
+</profile>
+```
+
+You can generate the docs with the following command:
+
+```
+mvn -Papidocs generate-resources
+```
+
+The documentation is always generated relative to the `target/site/apidocs` directory.  Hopefully that can be fixed in the future.