From cd6b1c97e341976031ff86ae49e62dce37ffcebb Mon Sep 17 00:00:00 2001
From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com>
Date: Sat, 16 Sep 2023 21:17:43 +0300
Subject: docs: update the readme

---
 README.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 569a79c..e446603 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
-# DemoParser [![Go Report Card](https://goreportcard.com/badge/github.com/pektezol/demoparser)](https://goreportcard.com/report/github.com/pektezol/demoparser) [![CI Badge](https://github.com/pektezol/DemoParser/actions/workflows/CI.yml/badge.svg)](https://github.com/pektezol/DemoParser/actions/workflows/CI.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/pektezol/DemoParser/blob/main/LICENSE)
-Work-In-Progress demo parser for Portal 2.
\ No newline at end of file
+# DemoParser [![Go Report Card](https://goreportcard.com/badge/github.com/pektezol/demoparser)](https://goreportcard.com/report/github.com/pektezol/demoparser) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/pektezol/DemoParser/blob/main/LICENSE)
+
+Work-In-Progress demo parser for Portal 2 written in Golang.
+
+Usage:
+
+```bash
+$ ./parser demo.dem
+```
+
+Currently supports:
+
+- File or folder input using the CLI.
+- Basic parsing of demo headers each message type.
+- Basic parsing of packet classes.
+- Custom injected SAR data parsing.
+
+TODO:
+
+- StringTableEntry parsing.
+- In-depth packet class parsing for each class.
-- 
cgit v1.2.3