add description in fr

README.md

@@ -1,4 +1,47 @@
 # NodeJS Converter of Mastodon export to HTML files
+-------------------------
+## FR: Présentation
+#Mastodon propose d'exporter une archive de vos données de compte. Informations utilisateur, posts, comptes que vous suivez, qui vous suivent, que vous avez bloqué, médias que vous avez posté...
+Mais il n'existe pas de moyen de visualiser tout le contenu de votre compte dans une jolie interface. Enfin, ça c'était avant.
+Maintenant vous pouvez utiliser ce client frontend pour naviguer dans vos posts et obtenir des statistiques à propos de votre compte, des hashtags que vous avez le plus utilisé, des comptes pour lesquels vous avez fait le plus de favoris et bien d'autres choses merveilleuses.
+Pour ce faire, suivez la documentation!
+
+## Initialiser le projet Mastodon-archive-stats
+
+Cloner le dépot et le faire fonctionner localement vous demandera d'avoir:
+* git
+* npm
+
+```
+git clone https://source.joinmastodon.org/tykayn/mastodon-archive-stats.git && cd mastodon-archive-stats
+yarn && yarn start
+```
+
+Il vous faudra d'abord avoir le zip d'export de votre compte, que vous pouvez demander dans votre espace utilisateur.
+Par exemple à cette adresse pour la meilleure instance Mastodon du fédiverse.
+
+https://mastodon.cipherbliss.com/settings/export
+
+" Vous pouvez demander une archive de vos pouets et médias téléversés. Les données exportées seront au format ActivityPub, lisible par tout logiciel compatible. Vous pouvez demander une archive tous les 7 jours. "
+
+Quand votre archive est prête vous recevez un email vous invitant à cliquer sur un lien pour récupérer le zip.
+Une fois ceci fait, vous allez pouvoir le décompresser et mettre son contenu dans le dossier **source_data** de ce projet.
+Les fichiers .json et compagnie, hop, coupé collé et voilà les informations à disposition du script.
+
+La config du projet se trouve dans le fichier main.js dont vous pouvez modifier la configuration de l'export. Pour par exemple n'afficher que les Toots de plus de 500 caractères, ou seulement ceux comportant des médias, et choisir le sens de priorité du filtrage.
+Vous avez le choix de sauvegarder le html rendu de l'export, ainsi que les statistiques générées dans un fichier séparé.
+
+Ensuite il vous suffira de lancer le serveur nodejs local avec un "yarn start", aller sur http://localhost:8080 et TADA! Votre export visuel est là.
+
+Have fun!
+
+
+-------------------------
+## EN: About
+This is a frontend visualizer to grasp some data about what you did on an export from your Mastodon account.
+Follow this doc to know how to use it.
+
+
 install dependencies
 Run the main.js file
 

main.js

@@ -9,10 +9,13 @@ const app = express();
 var fs = require('fs');
 var listenPort = 8088;
 var jsonParsedLikes, jsonParsedOutbox;
-// const min_length = 1050; // filter only long toots
-const min_length = 1; // filter only long toots
-const max_toots = 50; // filter only long toots
-const filterBiggerTottsBeforeSlicing = false; // filter only long toots
+/**
+ *  export configuration.
+ *  You can filter the export in the following vars
+ */
+const min_length = 1; // minmum character length of toots to display
+const max_toots = Infinity; // maximum length
+const filterBiggerTootsBeforeSlicing = false; // filter only long toots
 const filterOnlyHavingMedias = true; // filter only toots having medias
 const displayMedias = false; // filter only toots having medias
 const writeStatsJson = false; // filter only toots having medias
@@ -21,12 +24,12 @@ const TemplateVars = {
   pageTitle                     : 'Mastodon export converter to HTML',
   likes                         : jsonParsedLikes,
   outbox                        : jsonParsedOutbox,
-  outboxStatistics: {},
+  outboxStatistics              : {},
   outbox_all                    : jsonParsedOutbox,
   min_length,
   max_toots,
   filterOnlyHavingMedias,
-  filterBiggerTottsBeforeSlicing,
+  filterBiggerTootsBeforeSlicing,
   writeStatsJson,
   showMostRecentTootsOnTop,
   displayMedias,