diff --git a/README.md b/README.md index 18501c1..6428b79 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ -# edas +# EDAS -The Elite Dangerous API Service. Basically just a program that turns information from Elite Dangerous' journal files into an API with websocket support. \ No newline at end of file +The Elite Dangerous API Service. Basically just a tiny program that turns information from Elite Dangerous' journal +files into an API with websocket support. This program doesn't do anything on its own, but it allows other software to +access information about your game over the network. + +EDAS was built as a warm-up to EDIS, the Elite Dangerous Informational System. Kinda like my own version of EDCoPilot. +This is the backend system that will provide game data to EDIS. + +### Usage + +To use this, download the [Latest Release](https://git.bigduckie.dev/big-duckie/go-opds-pse/releases) and run it via +terminal. + +```shell +edas +``` + +### Building + +To build this you'll want the latest version of Go. Doesn't use any external libraries. + +### FAQs + +- Why Go? + +Well, Go is just very memory efficient. It's also one of my favourite languages. Yes, I could have written this as a +plugin for EDMC, and perhaps in the future I'll add similar features to this for EDSM, EDDB and Inara. Maybe even a +plugin system too. It's never a bad thing to offer alternatives to one program. + +- Is there a built-in UI for this? + +No. Not yet anyway. This first iteration is a pure cli program for offering an API for other programs to read from. I +do think I'll be building a desktop UI for this, similar to how EDCoPilot has a separate executable for the GUI. This +would allow you to have multiple UIs open at once. \ No newline at end of file