aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2020-05-09 17:12:25 +0200
committerDaniel Schadt <kingdread@gmx.de>2020-05-09 17:12:25 +0200
commitd75c559304b9deb5f09cfa6330ff7e0bf26c37ed (patch)
tree87ba5939a8085a89c72d8710fccb686351c5ffe9 /README.md
parent6c4d88a96b6f8d992324bae9a055195512710f1d (diff)
downloadevtclib-d75c559304b9deb5f09cfa6330ff7e0bf26c37ed.tar.gz
evtclib-d75c559304b9deb5f09cfa6330ff7e0bf26c37ed.tar.bz2
evtclib-d75c559304b9deb5f09cfa6330ff7e0bf26c37ed.zip
update documentation and README
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 3 insertions, 6 deletions
diff --git a/README.md b/README.md
index c68be25..babfd3d 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,7 @@ evtclib
[![Latest Version](https://img.shields.io/crates/v/evtclib.svg)](https://crates.io/crates/evtclib)
[![Rust Documentation](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/evtclib)
+[![License](https://img.shields.io/crates/l/evtclib.svg)](https://opensource.org/licenses/MIT)
`evtclib` is a Rust library that allows you to parse `.evtc` files, as
generated by the [arcdps addon](https://www.deltaconnected.com/arcdps/) for the
@@ -25,12 +26,8 @@ Example
use std::fs::File;
fn main() -> Result<(), Box<dyn std::error::Error>> {
- // Open a file for processing
- let mut file = File::open("Skorvald/20200421-183243.evtc")?;
- // Parse the raw content of the file
- let raw_log = evtclib::raw::parse_file(&mut file)?;
- // Process the file to do the nitty-gritty low-level stuff done
- let log = evtclib::process(&raw_log)?;
+ // Parse a log
+ let log = evtclib::process_file("Skorvald/20200421-183243.evtc")?;
// Do work on the log
for player in log.players() {
println!("Player {} participated!", player.account_name());