From 295087946f30b218b339dae746bcaf55ac5ea009 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Mon, 6 Jul 2020 17:12:01 +0100 Subject: [PATCH] README.md: Main blurb is in Wiki, direct there --- README.md | 37 ++++++++++--------------------------- 1 file changed, 10 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 8daa3715..cb68d96a 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,27 @@ -Any questions or offers of help can be directed to the Discord #edmc channel: +Any questions or offers of help can be directed to the EDCD Discord #edmc +channel: [![Discord chat](https://img.shields.io/discord/164411426939600896.svg?style=social&label=Discord%20chat)](https://discord.gg/usQ5e6n) Elite: Dangerous Market Connector (EDMC) ======== -This app downloads your Cmdr's details and system, faction, scan and station data from the game [Elite: Dangerous](https://www.elitedangerous.com/) and, at your choice, either: +This application is only of use to PC players of the game Elite Dangerous +(and its expansions). It won't work with PS4 or Xbox accounts. -* sends station commodity market prices, other station data, system and faction information and body scan data to the [Elite Dangerous Data Network](https://github.com/EDSM-NET/EDDN/wiki) (“EDDN”) from where you and others can use it via online trading, prospecting and shopping tools such as [eddb](https://eddb.io/), [EDSM](https://www.edsm.net/), [Elite Trade Net](http://etn.io/), [Inara](https://inara.cz), [Roguey's](https://roguey.co.uk/elite-dangerous/), [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki), etc. -* sends your Cmdr's details, ship details, cargo, materials and flight log to [Elite Dangerous Star Map](https://www.edsm.net/) (“EDSM”). -* sends your Cmdr's details, ship details, cargo, materials, missions, community goal progress, and flight log to [Inara](https://inara.cz). -* saves station commodity market prices to files on your computer that you can load into trading tools such as [Trade Dangerous](https://github.com/eyeonus/Trade-Dangerous/wiki) or [mEDI's Elite Tools](https://github.com/mEDI-S/mEDI_s-Elite-Tools). -* saves a record of your ship loadout to files on your computer that you can load into outfitting tools such as [E:D Shipyard](http://www.edshipyard.com), [Coriolis](https://coriolis.edcd.io) or [Elite Trade Net](http://etn.io/). +It utilises the Journal files written by the game on the user's computer, +together with data from the API Frontier Developments supplies in order to +feed this data to various third party sites that the user may find useful. -You can run the app on the same PC or Mac on which you're running Elite: Dangerous or on another PC connected via a network share. PS4 and Xbox are not supported, sorry. +See [the Wiki documenation](https://github.com/EDCD/EDMarketConnector/wiki) +for more details. -Usage --------- -The user-interface is deliberately minimal - your choice of data is automatically downloaded, transmitted and/or saved when you start Elite: Dangerous, land at a station, jump to a system or scan a body. Start the app before entering the game to ensure that you don't miss any data - some data is only available at game start. - -Click on the ship name to view its loadout on [E:D Shipyard](http://www.edshipyard.com) (“EDSY”) or [Coriolis](https://coriolis.edcd.io) in your web browser. - -Click on the system name to view its entry in [Elite: Dangerous Database](https://eddb.io/) (“eddb”), [Elite Dangerous Star Map](https://www.edsm.net/) (“EDSM”) or [Inara](https://inara.cz) in your web browser. - -Click on the station name to view its entry in [eddb](https://eddb.io/), [EDSM](https://www.edsm.net/) or [Inara](https://inara.cz) in your web browser. - -![Windows screenshot](img/win.png)   ![Mac screenshot](img/mac.png) - -![Windows screenshot](img/win_dark.png)   ![Mac screenshot](img/mac_dark.png) - -![Windows screenshot](img/win_transparent.png) Installation & Uninstall --- Please see the [Installation & Setup](https://github.com/EDCD/EDMarketConnector/wiki/Installation-&-Setup) wiki page. + Plugins -------- Plugins extend the behaviour of this app. To install a downloaded plugin: @@ -80,10 +67,6 @@ If your configuration has been corrupted, or badly set, such that you can't run Future updates will also be installed to this location. -### PS4 and Xbox support - -This app doesn't work with PS4 or Xbox Elite: Dangerous accounts. On these platforms the game lacks support for the API and Journal files that this app relies on. - ### Reporting a problem Please report a problem as a new GitHub [issue](https://github.com/EDCD/EDMarketConnector/issues/new). Please wait for the error to occur and zip up and attach this app's log file to the new issue: