Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
merterpam authored Jul 12, 2017
1 parent 6ee6bca commit 843621b
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,37 @@ ST-TWEC has three sub-modules: Tweet pre-processor, clustering tool and cluster

The explanation of the algorithm can be found on technical report [Tweets on a tree: Index-based clustering of tweets](http://research.sabanciuniv.edu/31274/1/Technical_Report.pdf).

# Usage
# Installation

In order to use the tool, you have 2 options:

### 1. Maven

* Add the following to the <repositories> section of your pom.xml:

```
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
```

* Add the following to the <dependencies> section of your pom.xml:

```
<dependency>
<groupId>com.github.merterpam</groupId>
<artifactId>ST-TWEC</artifactId>
<version>v1.0.0</version>
</dependency>
```

### 2. Jar file only

* Download the [latest .jar file](https://github.com/merterpam/ST-TWEC/releases) from the releases section.
* Add it to as your library and you can use ST-TWEC.

# Documentation

ST-TWEC requires a Tweet instance for a tweet. Tweet instances can be manually created, but it can also be automatically read from files. Utility class has a static function for this purpose. It can read tweets from a file with the following format:

Expand Down

0 comments on commit 843621b

Please sign in to comment.