Skip to content

Commit

Permalink
Merge branch 'master' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
akhawaja committed Jul 9, 2017
2 parents cb49a54 + 3a6a76f commit c4c1308
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 9 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,15 @@
A Java implementation of the [Segment's KSUID library](https://github.com/segmentio/ksuid). For a full treatment of why this came about, you can read the [blog post](https://segment.com/blog/a-brief-history-of-the-uuid/) on their website.

# Maven Central
At this time, the library is not published to Maven Central. This is work in progress.
This library can be downloaded from Maven Central by adding the following as a dependency in your pom.xml file:

``` xml
<dependency>
<groupId>com.amirkhawaja</groupId>
<artifactId>ksuid</artifactId>
<version>1.0.0</version>
</dependency>
```

# Quick Start
``` java
Expand Down
39 changes: 32 additions & 7 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
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.amirkhawaja</groupId>
<artifactId>ksuid</artifactId>
<version>1.0-SNAPSHOT</version>
<version>1.0.1-SNAPSHOT</version>

<name>ksuid</name>

<url>https://github.com/akhawaja/redisrqs-java</url>

<description>A Java port of Segment's K-Sortable Globally Unique IDs library written in Go.</description>

<licenses>
Expand Down Expand Up @@ -70,7 +71,7 @@
<profiles>
<!-- GPG Signature on release -->
<profile>
<id>release-sign-artifacts</id>
<id>release</id>
<activation>
<property>
<name>performRelease</name>
Expand Down Expand Up @@ -101,6 +102,28 @@
<build>
<finalName>${project.artifactId}-${project.version}</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>versions-maven-plugin</artifactId>
<version>2.3</version>
<configuration>
<generateBackupPoms>false</generateBackupPoms>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
Expand Down Expand Up @@ -160,7 +183,7 @@
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
Expand All @@ -174,8 +197,10 @@
</configuration>
<executions>
<execution>
<id>attach-javadoc</id>
<goals />
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/amirkhawaja/Base62.java
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* <a href="https://www.codeproject.com/Articles/1076295/Base-Encode">Code Project</a>
* </p>
*
* @author Amir Khawaja <khawaja.amir@gmail.com>
* @author Amir Khawaja khawaja.amir@gmail.com
*/
public class Base62 {

Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/amirkhawaja/Ksuid.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public Ksuid() {
/**
* Generate a new KSUID.
*
* @throws IOException Thrown when unable to generate a KSUID
* @return New KSUID value.
*/
public String generate() throws IOException {
Expand Down

0 comments on commit c4c1308

Please sign in to comment.