Project web

README.md

@@ -5,62 +5,9 @@ Java ME TOTP ([RFC 6238](http://tools.ietf.org/html/rfc6238)) authenticator. It
  * LinOTP authentication
  * other authentication servers which support TOTP
 
-## Download
+## Project web
 
-Download the [latest binaries](https://sourceforge.net/projects/totpme/files/latest/download)
-from the [SourceForge project pages](https://sourceforge.net/projects/totpme/).
-
-If you want to use direct installation to your device, use either [JAD](http://totpme.sourceforge.net/totp-me.jad)
-or [JAR](http://totpme.sourceforge.net/totp-me.jar).
-
-## Features
-
-Key (and only) features:
-
- * multiple profiles/accounts supported
- * configurable parameters
-   - secret key
-   - profile name
-   - digest algorithm: SHA-1 (default), SHA-256, SHA-512
-   - number of token digits (default is 6)
-   - time step (default is 30)
-   - time correction (default is 0) - advanced feature, the value (may be negative) is added to the device's system time
-     during computing a token value
- * input validation
- * key generator with Base32 and HEX output
-
-### Change log
-
-Check [Release notes](https://github.com/kwart/totp-me/blob/master/ReleaseNotes-README.md) for the list of changes.
-
-## Screenshots
-
-![Main screen](http://sourceforge.net/p/totpme/screenshot/totp-me-main.png)
-![List of profiles/accounts](http://sourceforge.net/p/totpme/screenshot/totp-me-profiles.png)
-
-![Options screen](http://sourceforge.net/p/totpme/screenshot/totp-me-options.png)
-![Key generator](http://sourceforge.net/p/totpme/screenshot/totp-me-key-generator.png)
-
-## How to install it
-
-Unzip files from the distribution package and copy `totp-me.jar` to your device which supports Java ME.
-Some devices may also need the description file `totp-me.jad` to be copied together with the JAR.
-
-## How to use it
-
-You either have already a secret key, then fill it as Base32 encoded String after the start (Options
-form is displayed if no key is set already). Or you can generate the secret key directly by the application and then
-fill it as a shared secret in the authentication server.
-
-### Generate new secret key
-
- * choose your preferred digest algorithm in the `Options` screen (the default is `SHA-1`)
- * choose `Key generator` from the menu - it will switch you to screen for generating the new key
- * use `New key` command to generate a new key, you can use it more times if you are not satisfied with the generated value
- * fill the `HEX` value in you authentication server configuration
- * press `OK` command and you will be switched back to the `Options` screen; confirm your configuration and press `OK` command again
- * if no problem occurs, you are switched to the main application screen, where the `Token` value is already present
- * _you can synchronize the authentication server with your token now_
+URL: http://totpme.sourceforge.net
 
 ## Development
 

pom.xml

@@ -7,7 +7,7 @@
 
 	<groupId>org.jboss.totp</groupId>
 	<artifactId>totp-me</artifactId>
-	<version>1.7</version>
+	<version>1.8</version>
 	<packaging>jar</packaging>
 
 	<name>TOTP ME</name>
@@ -18,7 +18,7 @@
 	</organization>
 
 	<properties>
-		<version.suffix>.Final</version.suffix>
+		<version.suffix>-SNAPSHOT</version.suffix>
 
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<microemulator.version>2.0.3</microemulator.version>
@@ -124,6 +124,18 @@
 						</execution>
 					</executions>
 				</plugin>
+				<plugin>
+					<groupId>org.apache.maven.plugins</groupId>
+					<artifactId>maven-site-plugin</artifactId>
+					<version>3.3</version>
+					<dependencies>
+						<dependency><!-- add support for ssh/scp -->
+							<groupId>org.apache.maven.wagon</groupId>
+							<artifactId>wagon-ssh</artifactId>
+							<version>2.5</version>
+						</dependency>
+					</dependencies>
+				</plugin>
 			</plugins>
 		</pluginManagement>
 
@@ -146,7 +158,6 @@
 				<executions>
 					<execution>
 						<id>copy-resources</id>
-						<!-- here the phase you need -->
 						<phase>validate</phase>
 						<goals>
 							<goal>copy-resources</goal>
@@ -274,6 +285,13 @@
 		</profile>
 	</profiles>
 
+	<distributionManagement>
+		<site>
+			<id>totpme.sf.net</id>
+			<url>sftp://web.sourceforge.net/home/project-web/totpme/htdocs</url>
+		</site>
+	</distributionManagement>
+
 	<repositories>
 		<repository>
 			<id>lcrypto</id>

src/site/markdown/index.md

@@ -6,8 +6,6 @@ Java ME TOTP ([RFC 6238](http://tools.ietf.org/html/rfc6238)) authenticator. It
  * LinOTP authentication
  * other authentication servers which support TOTP
 
-
-
 ## Download
 
 Download the [latest binaries](https://sourceforge.net/projects/totpme/files/latest/download)
@@ -34,7 +32,7 @@ Key (and only) features:
 
 ### Change log
 
-Check [Release notes](https://github.com/kwart/totp-me/blob/master/ReleaseNotes-README.md) for the list of changes.
+Check [Release notes](ReleaseNotes-README.html) for the list of changes.
 
 ## Screenshots
 
@@ -67,34 +65,7 @@ fill it as a shared secret in the authentication server.
 
 ## Development
 
-You can simply build the software yourself.
-
-### How to get the sources
-
-You should have [git](http://git-scm.com/) installed
-
-	$ git clone git://github.com/kwart/totp-me.git
-
-or you can download [current sources as a zip file](https://github.com/kwart/totp-me/archive/master.zip)
-
-### How to build it
-
-You need to have [Maven](http://maven.apache.org/) installed
-
-	$ cd totp-me
-	$ mvn clean package
-
-This default build uses Microemulator API implementation to simplify the build process, but it's only MIDP-2.0
-implementation. To be sure the source code is __MIDP-1.0 compatible__, you should install Oracle WTK and provide
-path to it to Maven as `wtk.home` system property
-
-	$ mvn clean package -Dwtk.home=/opt/WTK2.5.2
-
-### How to run it in the Microemulator
-
-Just use `exec:java` goal after you've successfully built the project
-
-	$ mvn exec:java
+Check [README](https://github.com/kwart/totp-me#development) on GitHub project pages.
 
 ## License
 

src/site/site.xml

@@ -1,7 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project name="totp-me" xmlns="http://maven.apache.org/DECORATION/1.0.0"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
+<project name="totp-me">
 
 	<skin>
 		<groupId>org.apache.maven.skins</groupId>
@@ -12,8 +10,11 @@
 	<body>
 		<menu name="totp-me">
 			<item name="About" href="index.html" />
+			<item name="Download" href="http://sourceforge.net/projects/totpme/files/" target="_blank" />
+			<item name="Release notes" href="ReleaseNotes-README.html" />
 			<item name="totp-me as Google Authenticator" href="totp-me_as_GoogleAuthenticator.html" />
-			<item name="Download" href="http://sourceforge.net/projects/totpme/files/" />
+			<item name="Bugs and issues" href="https://github.com/kwart/totp-me/issues" target="_blank" />
+			<item name="Source code (github)" href="https://github.com/kwart/totp-me" target="_blank" />
 		</menu>
 	</body>
 </project>