aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArda Serdar Pektezol <1669855+pektezol@users.noreply.github.com>2023-09-16 21:17:43 +0300
committerArda Serdar Pektezol <1669855+pektezol@users.noreply.github.com>2023-09-16 21:39:43 +0300
commitcd6b1c97e341976031ff86ae49e62dce37ffcebb (patch)
treef00c39237d8bcf704393643d6457180accbc6044
parentfeat: parsing sar custom data (#4) (diff)
downloadsdp.go-cd6b1c97e341976031ff86ae49e62dce37ffcebb.tar.gz
sdp.go-cd6b1c97e341976031ff86ae49e62dce37ffcebb.tar.bz2
sdp.go-cd6b1c97e341976031ff86ae49e62dce37ffcebb.zip
docs: update the readme
-rw-r--r--README.md23
1 files changed, 21 insertions, 2 deletions
diff --git a/README.md b/README.md
index 569a79c..e446603 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
1# 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) 1# 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)
2Work-In-Progress demo parser for Portal 2. \ No newline at end of file 2
3Work-In-Progress demo parser for Portal 2 written in Golang.
4
5Usage:
6
7```bash
8$ ./parser demo.dem
9```
10
11Currently supports:
12
13- File or folder input using the CLI.
14- Basic parsing of demo headers each message type.
15- Basic parsing of packet classes.
16- Custom injected SAR data parsing.
17
18TODO:
19
20- StringTableEntry parsing.
21- In-depth packet class parsing for each class.