From 4c817005cab5730e958f8d3345db4773d161a9f3 Mon Sep 17 00:00:00 2001 From: Anna Wiggins Date: Thu, 21 Jan 2016 14:33:04 -0500 Subject: [PATCH] Update readme to reflect new targets for the library. --- Readme.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/Readme.md b/Readme.md index f835289..d70a793 100644 --- a/Readme.md +++ b/Readme.md @@ -1,9 +1,14 @@ -# inara.py +# elite_api -This is a simple python library that is used to retrieve and store data to inara.py. +This is a simple python library that can: +* Retrieve and store select data on . +* Retrieve data from the Elite: Dangerous Companion API. -It subclasses requests_cache.core.CachedSession to provide a specialized HTTP session to talk to inara. -Usage is simple: + +### inara.py + +The inara module subclasses requests_cache.core.CachedSession to provide a specialized +HTTP session to talk to inara. Usage is simple: from inara.inara import InaraSession @@ -19,3 +24,9 @@ If the logged-in user is a member of a Wing, you can get information about wing- info = session.get_cmdr_info(wing_id, cmdr_id) where the 'id's are the numeric identifiers visible in inara's URLs. + + +### companion.py + +This module just provides a cleaner interface on top of the companion module from the +Elite Dangerous Market Connector.