Permalink
Browse files

Updating the readme and pom.xml files. Will deploy the generated site…

… to the gh-pages branch when the site target is run.
  • Loading branch information...
1 parent 51f6192 commit 649612b83b301059841bed8aaf641deb24ca2c14 @ngerakines committed Feb 26, 2012
Showing with 85 additions and 17 deletions.
  1. +18 −17 README.markdown
  2. +67 −0 pom.xml
View
@@ -2,20 +2,21 @@
Who Is That is a web application that allows people to sign up, connect their social network accounts and add small blurbs about the people they've friended.
-# Roadmap
-
-* GitHub integration
-* Foursquare integration
-* LinkedIn integration
-* Merge/alias support
-* Find siblings support
-* Tags
-* User entered records
-
-# Known Issues
-
-* Doesn't support anything other than in-memory, temporary storage with h2db.
-* Account object retrieves a password needlessly.
-* Doesn't support messages and should.
-* Connect status page is really ugly.
-* Has very poor test code coverage.
+# Requirements
+
+The only hard requirement is Java 6. This project has not been tested with any other Java versions.
+
+# Contributing
+
+To get the project running, simply check it out, package it and execut the cargo:run target:
+
+ $ git clone git://...ngerakines/whoisthat.git ngerakines-whoisthat
+ $ cd ngerakines-whoisthat
+ $ mvn package cargo:run
+ $ open http://localhost:8080/
+
+Using the "site" target, the project will run through unit tests and generate documentation and code coverage reports.
+
+ $ mvn site
+
+Please note, this project is configured to use the github maven plugin so executing the site plugin will make it attempt to upload to the gh-pages branch.
View
67 pom.xml
@@ -11,8 +11,37 @@ http://maven.apache.org/maven-v4_0_0.xsd">
<packaging>war</packaging>
<name>Who Is That?</name>
+ <description>A social network friendlist note manager.</description>
<url>https://github.com/ngerakines/whoisthat</url>
+ <issueManagement>
+ <url>https://github.com/ngerakines/whoisthat/issues</url>
+ <system>GitHub Issues</system>
+ </issueManagement>
+
+ <licenses>
+ <license>
+ <name>MIT License</name>
+ <url>http://www.opensource.org/licenses/mit-license.php</url>
+ <distribution>repo</distribution>
+ </license>
+ </licenses>
+
+ <scm>
+ <url>https://github.com/ngerakines/whoisthat</url>
+ <connection>scm:git:git://github.com/ngerakines/whoisthat.git</connection>
+ <developerConnection>scm:git:git@github.com:ngerakines/whoisthat.git</developerConnection>
+ </scm>
+
+ <developers>
+ <developer>
+ <email>nick@gerakines.net</email>
+ <name>Nick Gerakines</name>
+ <url>https://socklabs.com/</url>
+ <id>ngerakines</id>
+ </developer>
+ </developers>
+
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
@@ -164,6 +193,14 @@ http://maven.apache.org/maven-v4_0_0.xsd">
<url>http://maven.springframework.org/milestone</url>
</repository>
</repositories>
+
+ <pluginRepositories>
+ <pluginRepository>
+ <id>oss-sonatype-snapshots</id>
+ <url>https://oss.sonatype.org/content/repositories/releases/</url>
+ </pluginRepository>
+ </pluginRepositories>
+
<build>
<plugins>
<plugin>
@@ -204,6 +241,22 @@ http://maven.apache.org/maven-v4_0_0.xsd">
<artifactId>maven-site-plugin</artifactId>
<version>3.0</version>
</plugin>
+ <plugin>
+ <groupId>com.github.github</groupId>
+ <artifactId>site-maven-plugin</artifactId>
+ <version>0.5</version>
+ <configuration>
+ <message>Creating site for ${project.version}</message>
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>site</goal>
+ </goals>
+ <phase>site</phase>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
@@ -229,6 +282,20 @@ http://maven.apache.org/maven-v4_0_0.xsd">
</formats>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <notimestamp>true</notimestamp>
+ <linksource>true</linksource>
+ <links>
+ <link>http://commons.apache.org/lang/api</link>
+ <link>http://java.sun.com/j2se/1.6.0/docs/api</link>
+ <link>http://static.springsource.org/spring/docs/3.1.0.RELEASE/javadoc-api/</link>
+ <link>http://joda-time.sourceforge.net/apidocs</link>
+ </links>
+ </configuration>
+ </plugin>
</plugins>
</reporting>
</project>

0 comments on commit 649612b

Please sign in to comment.