Skip to content

Commit

Permalink
updated readme (#273)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
csharpfritz and github-actions[bot] authored Nov 2, 2023
1 parent 13972c8 commit 74f2c45
Showing 1 changed file with 40 additions and 31 deletions.
71 changes: 40 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,40 @@
# TagzApp
A new website tool that searches social media for hashtags, and tracks chat interaction on several live streaming services

![Sample Screenshot from August 7, 2023](doc/img/Screenshot-2023-09-26.png)

### Overlay display

When some content is selected on the waterfall display, we have an overlay available that can be used with a video capture device

![image](https://github.com/FritzAndFriends/TagzApp/assets/78577/0d7e422a-166a-4d7d-8ea5-ea59f3f4ccbd)


## Current Status

We have completed an initial minimum viable product and stress tested the application by capturing tweets during the NFL kickoff grame on September 7, 2023 between Kansas City and Detroit using the hashtag #DETvsKC

Data is stored in a combination of Sqlite and Postgres databases. We have configured an extensive provider model so that we can add new social media services in the future.

Live chat integration (TwitchChat, YouTubeChat, etc) captures all messages that are delivered over that service.

We also have a simple moderation capability.

### Currently Supported Services

- [Blazot](https://www.blazot.com/)
- Mastodon
- Twitter / X
- TwitchChat
- YouTube (search for videos that have a given hashtag in the description)


# TagzApp
A new website tool that searches social media for hashtags, and tracks chat interaction on several live streaming services

![Sample Screenshot from August 7, 2023](doc/img/Screenshot-2023-09-26.png)

### Overlay display

When some content is selected on the waterfall display, we have an overlay available that can be used with a video capture device

![image](https://github.com/FritzAndFriends/TagzApp/assets/78577/0d7e422a-166a-4d7d-8ea5-ea59f3f4ccbd)


## Current Status

We have completed an initial minimum viable product and stress tested the application by capturing tweets during the NFL kickoff grame on September 7, 2023 between Kansas City and Detroit using the hashtag #DETvsKC

Data is stored in a combination of Sqlite and Postgres databases. We have configured an extensive provider model so that we can add new social media services in the future.

Live chat integration (TwitchChat, YouTubeChat, etc) captures all messages that are delivered over that service.

We also have a simple moderation capability.

## Keyboard navigation supported on moderation screen

On the moderation screen, you can use the keyboard to navigate the cards on screen:

- arrows to move a cursor between the various messages
- HJKL to move a cursor using 'vim' style cursor movement- Enter to select a message for moderation
- Y to approve a message
- N to reject a message

### Currently Supported Services

- [Blazot](https://www.blazot.com/)
- Mastodon
- Twitter / X
- TwitchChat
- YouTube (search for videos that have a given hashtag in the description)


Expand Down

0 comments on commit 74f2c45

Please sign in to comment.