update readme

This commit is contained in:
Baptiste Lemoine 2020-07-18 17:51:25 +02:00
parent e8ff25eb06
commit 0aaad30421

View File

@ -2,4 +2,39 @@
install dependencies install dependencies
Run the main.js file Run the main.js file
It will create a file showing your longest posts. It will create a file showing your longest posts if you want.
initialize this project with its dependencies, copy paste the source_data of your linkes.json and outbox.json to get an HTML export on a node server.
```bash
git clone https://source.joinmastodon.org/tykayn/mastodon-archive-stats.git && cd mastodon-archive-stats
mkdir source_data
yarn
node main.js
```
copy paste the source_data of your linkes.json and outbox.json to the **source_data** folder
open your browser to
http://localhost:8088/
and you will see the result in html.
## What statistics does this provide
For the moment:
* who you talked to the most, with counters. This uses the object.cc field of a toot.
## configuration
Change vars in the main.js file.
## Format restriction
this viewer works with archives exported at the time of this writing, July 2020.
## That is messy code with a bad UI and you should feel bad
it is, yes!
Feel free to contribute with a merge request.
#Contact me
Tykayn on mastodon, on my own instance:
https://mastodon.cipherbliss.com/@tykayn
Other works about web and drawings:
https://www.cipherbliss.com
https://tykayn.fr