diff --git a/README.md b/README.md new file mode 100644 index 0000000..72034eb --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# samp-plugin-xml + +[![sampctl](https://img.shields.io/badge/sampctl-samp--plugin--xml-2f2f2f.svg?style=for-the-badge)](https://github.com/marevin/samp-plugin-xml) + +XML plugin for SA-MP server +Provides API for parsing XML files +[Developed by Zeex](https://github.com/Zeex/samp-plugin-xml/) + +Forked repository for compatibility with sampctl + +~~http://forum.sa-mp.com/showthread.php?t=150755~~ +https://sampforum.blast.hk/showthread.php?tid=150755 +(Backup of an outdated thread with outdated code. Archive purposes only) + +## Installation + +Simply install to your project: + +```bash +sampctl package install Marevin/samp-plugin-xml +``` + +Include in your code and begin using the library: + +```pawn +#include +``` + +## Usage + + +Native functions are documented in the ```xml.inc``` file. + +Note: +The following functions are hardcoded to look for files in the ```scriptfiles/``` path. + +``` +XML_CreateDocument +XML_LoadDocument +XML_SetValue +``` + +## Testing + + + +To test, simply run the package: + +```bash +sampctl package run +```