add README

This commit is contained in:
Florian Stinglmayr 2025-07-30 13:18:57 +02:00
parent d7b407db78
commit ec41c718b1

12
README.md Normal file
View File

@ -0,0 +1,12 @@
# EDPlayerJournal
EDPlayerJournal is a C# library for parsing and working with the
Elite: Dangerous player journal. The journal consists of a series of text
files containing a JSON object per line (JSONL) that gets continuously
updated by the engine as the player plays the game.
## BGS Engine
The project also contains the BGS engine, which tallies BGS activities from
the journal. It is the heart of the EDBGS app, which creates BGS reports
that show a players daily BGS activity in the game.