Update Docs

Author: robotastic

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (c) 2020-2023 IQT Labs LLC, All Rights Reserved.
+   Copyright (c) 2020-2024 IQT Labs LLC, All Rights Reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -26,95 +26,47 @@
 
 <br />
 <div align="center">
-  <a href="https://iqtlabs.org/">
-    <img src="images/logo.png" alt="Logo" width="331" height="153">
+  <a href="https://iqt.org">
+    <img src="images/logo.png" alt="Logo" width="358" height="132">
   </a>
-
-<h1 align="center">EdgeTech-Object-Ledger</h1>
-
-  <p align="center">
-  This project manages a ledger of moving objects, such as aircraft or
-  ships, that can be used for pointing a camera at the object.
-  <br/>
-  <br/>
-  In more detail, the object ledger subscribes to MQTT message topics
-  for ADS-B messages, which provide aircraft position and velocity,
-  and AIS messages, which provide ship position and velocity. Each
-  messages corresponds to a uniquely identifiable object which is used
-  to update a ledger by unique identifier. A figure of merit is
-  computed for each object, and one object selected for tracking. The
-  ledger is maintained in a Pandas DataFrame, which is serialized to
-  local storage so that the history of objects selected for tracking
-  can be used by the figure of merit calculation. All object ledger
-  parameters can be customized through environment variables, or using
-  an MQTT message published to a configuration topic. Units of measure
-  are meters, seconds, and degrees, and operation of the object ledger
-  is extensively logged.
-    <br/>
-    <br/>
-    <a href="https://github.com/IQTLabs/edgetech-template/pulls">Make Contribution</a>
-    ·
-    <a href="https://github.com/IQTLabs/edgetech-template/issues">Report Bug</a>
-    ·
-    <a href="https://github.com/IQTLabs/edgetech-template/issues">Request Feature</a>
-  </p>
 </div>
+<h1 align="center">EdgeTech Object Ledger</h1>
+
+
+This project manages a ledger of moving objects, such as aircraft or
+ships, that can be used for pointing a camera at the object.
+
+In more detail, the object ledger subscribes to MQTT message topics
+for ADS-B messages, which provide aircraft position and velocity,
+and AIS messages, which provide ship position and velocity. Each
+messages corresponds to a uniquely identifiable object which is used
+to update a ledger by unique identifier. A figure of merit is
+computed for each object, and one object selected for tracking. The
+ledger is maintained in a Pandas DataFrame, which is serialized to
+local storage so that the history of objects selected for tracking
+can be used by the figure of merit calculation. All object ledger
+parameters can be customized through environment variables, or using
+an MQTT message published to a configuration topic. Units of measure
+are meters, seconds, and degrees, and operation of the object ledger
+is extensively logged.
+
+## Usage
+
+This module is designed to be used in concert with other modules to
+build a complete tracking system. [SkyScan](https://github.com/IQTLabs/SkyScan), 
+which tracks aircraft using ADS-B transmissions, is an example of the type of 
+system that can be built.
+
+ Checkout the `docker-compose.yml` in that repo to see how these modules
+ can be connected together. The configuration for the system is stored in `.env` environment files. Examples of the different environment files
+ are included in the **SkyScan** repo and can be configured them to match your setup.
 
 ### Built With
 
 [![Python][python]][python-url]
 [![Poetry][poetry]][poetry-url]
 [![Docker][docker]][docker-url]
 
-## Getting Started
-
-To run this repo, simply run:
-
-```
-docker-compose up
-```
-
-### Prerequisites
-
-Running this repo requires that you have
-[Docker](https://www.docker.com) for containerization,
-[Poetry][poetry-url] for dependency management, and [Python
-3.11.1][python-url] is the version we've been building with.
-
-## Usage
-
-Spinning up this system requires an MQTT server and this container to
-be included in your `docker-compose.yml`. You can find an example of
-this workflow in this repository's `docker-compose.yml`. Additionally,
-some editing of relevant environment variables will be required based
-upon your system's configuration of topics to subscribe to and MQTT
-configuration. Examples of these environment variables can be found in
-this repository's `axis-ptz-controller.env` file.
-
-Copying the project `docker-compose` statements into a master
-`docker-compose.yml` and `.env` files with your entire system of
-containers is the preferred workflow. Find an application architecture
-diagram example of how the usage of this module was envisioned below.
-
-```mermaid 
-
-flowchart TD
-    configdata(Config Data) -- Config Topic --> mqtt{MQTT}
-    orientationdata(Orientation Data) -- Orientation Topic --> mqtt{MQTT}
-    flightdata(Flight Data) -- Flight Topic --> mqtt{MQTT}
-    mqtt{MQTT} -- Config, Orientation, and Flight Topics --> controller(Controller)
-    controller(Controller) --> capturedata(Capture Data)
-    capturedata(Capture Data) -- Capture Topic --> mqtt{MQTT}
-
-style mqtt fill:#0072bc,color:#ffffff
-style configdata fill:#80c342,color:#ffffff
-style orientationdata fill:#80c342,color:#ffffff
-style flightdata fill:#80c342,color:#ffffff
-style controller fill:#F9D308,color:#ffffff
-style capturedata fill:#80c342,color:#ffffff
-
-```
-
 ## Roadmap
 
 - TBA
@@ -149,7 +101,7 @@ See `CONTRIBUTING.md` for more information.
 ## License
 
 Distributed under the [Apache
-2.0](https://github.com/IQTLabs/edgetech-template/blob/main/LICENSE). See
+2.0](https://github.com/IQTLabs/edgetech-object-ledger/blob/main/LICENSE). See
 `LICENSE.txt` for more information.
 
 ## Contact IQTLabs