Skip to content
Permalink
Browse files

Update README.md

  • Loading branch information...
shawnmjones committed May 10, 2019
1 parent 3e43c6f commit e5dde22c6da50af5a2bd911a1d268a69adb0b0bc
Showing with 3 additions and 0 deletions.
  1. +3 −0 README.md
@@ -12,6 +12,7 @@ Raintale accepts the following inputs:
* the author, organization, or algorithm that generated the story (optional)
* an output file for saving the story (if applicable)
* a credential file for the a social media service (if applicable)
* a template file allowing the user to format their story differently than the defaults (optional)

Raintale supports the following storytellers:
* facebook - (EXPERIMENTAL) this storyteller publishes a story as a Facebook thread, with titles, snippets, URLs, and memento-datetimes supplied by MementoEmbed
@@ -28,6 +29,8 @@ Railtale also supports a number of presets for formatting a story for output to
* thumbnails3col - provides a 3 column layout containing thumbnails of the submitted mementos
* thumbnails4col - provides a 4 column layout containing thumbnails of the submitted mementos

Note that not all file formats support all presets.

# Running raintale

Raintale uses docker-compose to load and execute all dependencies. To run raintale, do the following:

0 comments on commit e5dde22

Please sign in to comment.
You can’t perform that action at this time.