From 98ae88efe5223fad058f448169ef5b2c2b2ec4c5 Mon Sep 17 00:00:00 2001
From: BradBot_1 <BradBot_1@outlook.com>
Date: Fri, 30 Jun 2023 05:07:15 +0100
Subject: [PATCH] CHORE: start of readme

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1306e1c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Objective TOML
+
+> Want this for YAML? Checkout [ObjectiveYaml](https://github.com/BradBot1/ObjectiveYaml/tree/master)
+
+A `Java 17` GSON like approach to TOML
+
+> This project utilises [tomlj](https://github.com/tomlj/tomlj) internally
+
+> Serialization of an object is not supported, this simply replicates the functionality of JsonElement, JsonObject, JsonArray and JsonPrimitive from GSON for TOML
+
+## How to use
+Simply import fun.bb1.toml.Toml and invoke #parseString() with your TOML.
+
+```java
+import fun.bb1.toml.Toml;
+
+...
+
+TomlObject toml = Toml.parseString("example=1");
+```
+
+## Where to get it
+
+This project is hosted on [my Maven Repository](https://repo.bb1.fun/#/releases), you can grab it from there
+
+```xml
+<repository>
+	<id>bb1-repository-releases</id>
+	<name>BradBot_1's Repository</name>
+	<url>https://repo.bb1.fun/releases</url>
+</repository>
+```
+
+```xml
+<dependency>
+	<groupId>fun.bb1</groupId>
+	<artifactId>objectivetoml</artifactId>
+	<version><!-- The version you wish to install --></version>
+</dependency>
+```
\ No newline at end of file