From 4cb9df6cdde762ae85ac30048f5236653113eebf Mon Sep 17 00:00:00 2001 From: zervo Date: Fri, 14 Feb 2025 17:35:47 +0100 Subject: [PATCH] Update README.md --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/README.md b/README.md index 8d87b7c..9f53c08 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,47 @@ ![Stars status](https://git.zervo.org/FLUX/GoSBHPF/badges/stars.svg) GoSBHPF is a go library implementing the SBHPF binary format. + +It provides functions for serialization and deserialization of SBHPF trees and individual components (nodes and properties). + +Will also support efficient dynamic seeking of files in the future. + +## Installation + +Add the module to your project: + +`go get git.zervo.org/FLUX/GoSBHPF` + +Then use it in your code: + +```go +package main + +import ( + sbhpf "git.zervo.org/FLUX/GoSBHPF/SBHPFv1" +) + +func main() { + node := sbhpf.Node{} + + // Rest of code... +} +``` + +## Usage + +There are a variety of different functions and types in this package, but it can be simplified to: + +- (type) **Node:** Usable object representing SBHPF node. + +- (type) **Property:** Usable object representing SBHPF node property. + +- (type) **Value Type:** Usable object representing a SBHPF node property value type. + +All this terminology is outlined in the SBHPF version 1 standard. + +You can use these types to build a tree structure that can later be efficiently serialized to a raw SBHPF format. + +You can also deserialize raw SBHPF into a node object representing the original tree. + +**NOTE:** This library is in its early stages. Parsing performance will be improved over time, and more functions will be added (such as search algorithms). Because of this, the functions of the library are not documented here yet. They do however have quite descriptive comments, which can be viewed directly when consuming the library in any modern go-compatible IDE, or alternatively in the source code. \ No newline at end of file