add readme

README.md

@@ -0,0 +1,28 @@
+# Unwritten Application
+
+## API
+
+### `PUT` /generate_random
+
+NO BODY
+
+Used to generate random data in the database.
+Generates 10000 accounts and 1000000 transactions
+
+### `DELETE` /delete_data
+
+Used to delete the data from the database
+
+### `GET` /injest
+
+Injests the data from the database into polars LazyFrames
+
+Note: This should take around 1-2sec, I think that most of the delay comes from having to clone all the UUIDs into strings
+
+### `Get` /accounts
+
+Returns the text representaion of the accounts LazyFrame
+
+### `Get` /transactions
+
+Returns the text representaion of the transactions LazyFrame