Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ingalls committed Apr 19, 2024
1 parent 55bdac4 commit baf2e34
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Lightweight JavaScript library for parsing and manipulating TAK related messages

## About

`node-tak` converts between TAK message protocols and a Javascript object/JSON format.
It also can bidirectionally convert CoT messages into a GeoJSON format
`node-cot` converts between TAK message protocols and a Javascript object/JSON format.
It also can bidirectionally convert CoT messages into [GeoJSON](https://geojson.org/)

## Installation

Expand All @@ -21,8 +21,8 @@ npm install @tak-ps/node-cot

## CoT Spec

The CoT spec appears to be very informally developed by a rough internal concensus
by large TAK Clients within the TPC (TAK Product Center). The following is a current
The CoT Spec is very informally developed by rough internal concensus
of large TAK Clients within the TPC (TAK Product Center). The following is a current
understanding of the spec primarily developed through reverse engineering TAK clients

```
Expand Down Expand Up @@ -89,6 +89,8 @@ These are less common properties that can be used:
| --------------------------------- | ----------- |
| `.properties.icon` | String: Custom Icon Path (string) |
| `.properties.archived` | Boolean: TAK Clients will ignore the stale value and retain the feature |
| `.properties.dest` | Marti API Instructions for sending CoTs to a specific location |
| `.properties.fileshare` | Push Data Packages via CoT |

## Usage Examples

Expand Down Expand Up @@ -127,3 +129,4 @@ The following list is a very incomplete list of "special" CoT types and behavior
| `b-t-f-p` | Chat pending receipt |
| `b-t-f-s` | Chat delivery failure |
| `t-x-m-c-l` | Mission Change Notification |
| `t-x-m-i` | Mission Invite Notification |

0 comments on commit baf2e34

Please sign in to comment.