Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
koliva8245 committed Jun 28, 2024
1 parent 637e6d1 commit 40b3c18
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
[![Release](https://img.shields.io/github/release/HeroesToolChest/Heroes.MpqTool.svg)](https://github.com/HeroesToolChest/Heroes.MpqTool/releases/latest)
[![NuGet](https://img.shields.io/nuget/v/Heroes.MpqTool.svg)](https://www.nuget.org/packages/Heroes.MpqTool/)

Heroes Mpq Tool is a .NET library that is specifically for parsing Heroes of the Storm MPQ files.
Heroes Mpq Tool is a .NET library that is specifically designed for parsing Heroes of the Storm MPQ files.

## Usage
To parse an mpq file, such as a `.StormReplay` file, use `MpqHeroesFile.Open(string fileName)` by providing the path to the file. It will provide a `MpqHeroesArchive` object to allow access to the files inside of the archive.
To parse an mpq file, such as a `.StormReplay` or `.s2ma` file, use `MpqHeroesFile.Open(string fileName)` by providing the path to the file. It will provide a `MpqHeroesArchive` object to allow access to the files inside of the archive.

Example:
```C#
Expand Down

0 comments on commit 40b3c18

Please sign in to comment.