From 843621b9c14ec75b8acc71b6e679136ec5553e24 Mon Sep 17 00:00:00 2001 From: Mert Erpam Date: Wed, 12 Jul 2017 11:40:01 +0300 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 87cbda2..af16aa3 100644 --- a/README.md +++ b/README.md @@ -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 section of your pom.xml: + +``` + + jitpack.io + https://jitpack.io + +``` + + * Add the following to the section of your pom.xml: + +``` + + com.github.merterpam + ST-TWEC + v1.0.0 + +``` + +### 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: