Skip to content
This repository has been archived by the owner on Oct 16, 2022. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
totetmatt committed Nov 22, 2019
1 parent ba5dd7f commit 13f8a46
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Mediamur

## Disclamer

The purpose of this tools is to ease the visualization of media (photo, video) in twitter in real time.

Mediamur is reflecting the video activity of twitter users. It might contains unadapted contents for youth.
Expand All @@ -8,9 +10,15 @@ The tool doesn't have any control on what is send over Twitter. As **no** filter
Please be aware and use the tool in the correct place with the adequate participants.

## Twitter API

You will need to create a Twitter API Application Key https://developer.twitter.com/en/apps.

## Prerequisite

Mediamur needs Java to run.

## Quickstart

* Download here
* Unzip somewhere in your disk
* Edit the `application.conf`
Expand Down Expand Up @@ -38,26 +46,39 @@ You will need to create a Twitter API Application Key https://developer.twitter.

* With a console, go to `cd $PATH_WHERE_YOU_UNZIP/mediamur-0.1/` and run `bin/mediamur` (or windows `bin\mediamur.bat`)
* Open a web browser to `http://localhost:48099/`

## Example

### Media Flow

https://youtu.be/4LMWtduAhgE

Each new media is append on the top. You can click to see it.

### Media Stack

https://youtu.be/Qe5Kyz_bzfs

Each media is getting stack per number of time it has been seen.

### TV & Hashcloud

https://youtu.be/6phDxLYHZ9k

Will play automatically each video 1 by 1 by date Mediamur receive it and make a hashtag co-occurence cloud.
Each hashtag can be clicked to display video under this hashtag.

## Configuration

### query

The `track` represent the set of words that twitter will fetch as stream. It could be just words, hashtags etc...

### recordActive

If set to `true`, the application will store all media and tweets in a directory.

### sampleStream

If set to `true` and if the `query.track` is empty, it will use the twitter sample stream endpoint, which represent a random set
of tweets.

0 comments on commit 13f8a46

Please sign in to comment.