Skip to content

Commit

Permalink
Update readme for static html option. (#179)
Browse files Browse the repository at this point in the history
Signed-off-by: merobi-hub <merobi@gmail.com>
  • Loading branch information
merobi-hub authored Dec 25, 2023
1 parent 951790d commit 39b6126
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Slack team's export (instead of having to dive into hundreds of JSON files).

`slack-export-viewer` is useful for small teams on a free Slack plan (limited to 10,000 messages) who overrun their budget and ocassionally need a nice interface to refer back to previous messages. You get a web interface to easily scroll through all channels in the export without having to look at individual JSON files per channel per day.

`slack-export-viewer` can be used locally on one machine for yourself to explore an export or it can be run on a headless server (as it is a Flask web app) if you also want to serve the content to the rest of your team.
`slack-export-viewer` can be used locally on one machine for yourself to explore an export, it can be run on a headless server (as it is a Flask web app) if you also want to serve the content to the rest of your team, or it can output HTML for deploying a static website.


## Installation
Expand Down Expand Up @@ -81,7 +81,7 @@ Point slack-export-viewer to the .zip file and let it do its magic
slack-export-viewer -z /path/to/export/zip
```

If everything went well, your archive will have been extracted, processed, and browser window will have opened showing your *#general* channel from the export.
If everything went well, your archive will have been extracted and processed, and a browser window will have opened showing your *#general* channel from the export. Or, if the `html-only` flag was set, HTML files will be available in the `html-output` directory (or a different directory if specified).

## CLI

Expand Down

0 comments on commit 39b6126

Please sign in to comment.