Skip to content

Commit

Permalink
release v1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
spheenik committed Mar 22, 2015
1 parent d712ce6 commit 98fe7e1
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 33 deletions.
45 changes: 13 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# clarity

Comically fast, almost complete Dota 2 "demo" (aka "replay") parser written in java.
Comically fast, almost complete Dota 2 "demo" (aka "replay") parser written in java.

### Note

This is the README for version 1 of the library, so you might wanna check out
[version 2](https://github.com/skadistats/clarity).

### Upgrading from an earlier 1.x
The protobuf-classes used by clarity have been factored out into a separate project, to make reuse among
v1 and v2 possible. While doing that I also moved them to another package, so when you want to move to 1.2
you might have to adjust a lot of imports. A global search and replace from `com.dota2.proto.` to
`skadistats.clarity.wire.proto.` on your whole project should do the trick.

# Replay Data

Expand Down Expand Up @@ -63,37 +74,7 @@ To use the stable version, add the following dependency in your pom.xml, and you
<dependency>
<groupId>com.skadistats</groupId>
<artifactId>clarity</artifactId>
<version>1.1</version>
</dependency>
```

There is also the possibility to use the bleeding edge, which I try to keep in sync with the Git-Repo.
However, this latest snapshot is not available in Maven Central, so you got to add a pointer to the
repository to your pom.xml (see the [pom.xml of clarity-examples](https://github.com/skadistats/clarity-examples/blob/v1/pom.xml), which already does that)

To add the snapshot repository, add the following:
```XML
<repositories>
<repository>
<id>sonatype.oss.snapshots</id>
<name>Sonatype OSS Snapshot Repository</name>
<url>http://oss.sonatype.org/content/repositories/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
```

and then fetch the dependency with:
```XML
<dependency>
<groupId>com.skadistats</groupId>
<artifactId>clarity</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.2</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.skadistats</groupId>
<artifactId>clarity</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.2</version>
<packaging>jar</packaging>
<name>clarity</name>
<description>Clarity is a fast, almost complete replay parser for Dota 2.</description>
Expand Down

0 comments on commit 98fe7e1

Please sign in to comment.