diff --git a/README.md b/README.md new file mode 100644 index 0000000..4523e0f --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file