diff --git a/README.md b/README.md index 7cdbab0..fecd85d 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,10 @@ Install the RustWorldJS package into your project npm install rustworld ``` + ## Usage -``` +```javascript import * as rustWorld from "rustworld"; import * as fs from "fs"; @@ -34,6 +35,7 @@ The package comes with Typescript definitions so if you are using Typescript you - [get-terrainmap-info](https://github.com/Dezinater/RustWorldJS/tree/master/examples/get-terrainmap-info) - [ice-walls](https://github.com/Dezinater/RustWorldJS/tree/master/examples/ice-walls) + ## LZ4 Compression The original [Rust.World SDK](https://github.com/Facepunch/Rust.World) and the game itself uses LZ4 compression for map reading and writing. They use a library called [lz4net](https://github.com/MiloszKrajewski/lz4net) which is now outdated and has a custom implementation of LZ4. RustWorldJS recreates and uses that same custom implementation of LZ4.