From 23802f1572380afd59c5925b577c2183f291c5cb Mon Sep 17 00:00:00 2001
From: Joel Wetzell <jwetzell@yahoo.com>
Date: Wed, 13 Sep 2023 15:59:52 -0500
Subject: [PATCH] update readme

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 53 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 41bcfdc..36a23d1 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,55 @@
 # psn-js
-**!!DISCLAIMER!!**
 
-This library is still a work-in-progress. I have gotten quick proof-of-concept working and complete implementation of the [PosiStageNet](https://github.com/vyv/psn-cpp/blob/master/doc/PosiStageNetprotocol_v2.03_2019_09_09.pdf) protocol is still being worked on. Please report anything you see that is not in compliance with the protocol. 
+## Install
+`npm install --save @jwetzell/posistagenet`
+
+## Usage
+
+### Decode - [example](./examples/psn_client.js)
+```
+const { Decoder } = require('@jwetzell/posistagenet')
+const decoder = new Decoder()
+
+const buffer = Buffer.from('source PSN packets from somewhere')
+
+decoder.decode(buffer)
+
+// data from PSN Info packets
+console.log(decoder.info)
+
+// data from PSN Data packets
+console.log(decoder.data)
+
+```
+
+### Encode - [example](./examples/psn_server.js)
+```
+const { Encoder, Tracker } = require('@jwetzell/posistagenet')
+const encoder = new Encoder('Server Name', 2,3) //server name, version high, version low
+
+const trackers = []
+
+const tracker = new Tracker(1,'Tracker 1') // id, name
+tracker.setPos(1.0,1.0,1.0) // x, y, z
+
+trackers.push(tracker)
+
+const timestamp = 1;
+
+
+// these two calls return an array of Buffers due to potential splitting that might take place because of max UDP packet size
+const dataPackets = encoder.getDataPackets(timestamp, trackers)
+const infoPackets = encoder.getInfoPackets(timestamp, trackers)
+
+dataPackets.forEach((dataPacket)=>{
+    console.log('send packet somehow')
+    console.log(dataPacket.toString('hex'))
+})
+
+infoPackets.forEach((infoPacket)=>{
+    console.log('send packet somehow')
+    console.log(infoPacket.toString('hex'))
+})
+
+```
+