docs: Add README

README.md

@@ -0,0 +1,42 @@
+# LrndefLib
+LrndefLib provides a version-based config file
+
+![GitHub license](https://img.shields.io/github/license/Arthri/LrndefLib?style=flat-square) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Arthri/LrndefLib?sort=semver&style=flat-square) ![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/Arthri/LrndefLib?include_prereleases&sort=semver&style=flat-square)
+
+## Goals
+
+### Version Ambiguity
+The config file implementation provided by TShock can't differentiate between config versions without iterating the whole file. LrndefLib provides an alternative implementation that instead compares a single property "metadata:version". However, the schema isn't strictly enforced
+
+### Migrations
+LrndefLib allows for config migrations during parsing. However, you need to provide your own migration implementation. LrndefLib can't migrate by default, it binds the config 1:1 as if it were any other version
+
+Migrations can be implemented by modifying `VersionedConfigFile.BindDelegate`. The delegate is called in the middle of parsing to bind a `JObject` to a config object
+
+## Installation
+
+### With Paket
+1. Install and set up Paket
+2. Add `http https://github.com/Arthri/LrndefLib/releases/[VERSION]/download/LrndefLib.zip packages/LrndefLib/LrndefLib.zip` to your `paket.dependencies`
+    - Replace `[VERSION]` with your desired version. **DO NOT** use `latest`.
+3. Run `dotnet paket install`
+4. Add `paket-files/github.com/packages/LrndefLib/LrndefLib.dll` as a reference
+
+## Usage
+1. Create a new config class that inherits from `VersionedSettings`. If one already exists, make it inherit `VersionedSettings`
+2. Create a new instance of `VersionedConfigFile` like so: `var configFile = new VersionedConfigFile<TSettings>(CurrentVersion);`
+    - replace `TSettings` with the class you created earlier
+    - replace `CurrentVersion` with the current version of the config
+3. Read the config file: `configFile.Read(configPath, out bool _)`;
+
+## Unofficial Conventions
+
+### CurrentVersion
+A config's "`CurrentVersion`" is its latest iteration. Ideally, it should follow [SemVer][SemVer]. Since configs change rarely, ideally, `CurrentVersion` should NOT be derived from the assembly version
+
+
+
+
+
+<!-- DEFINITIONS -->
+[SemVer]: https://semver.org/