From 43b11ab29528664d4acbf69545b998df72cd5ea7 Mon Sep 17 00:00:00 2001
From: ztimson <zaktimson@gmail.com>
Date: Tue, 19 Dec 2023 23:08:37 -0500
Subject: [PATCH] updated readme

---
 README.md    | 117 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 package.json |   2 +-
 2 files changed, 117 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 02829eb..7fa4501 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,116 @@
-# Persist
+<!-- Header -->
+<div id="top" align="center">
+  <br />
+
+  <!-- Logo -->
+  <img src="https://git.zakscode.com/repo-avatars/2b4ee6ba1f2e2618bf7694e4a52fb56d1d0ea6abafa2dcbe496ab786b86d5a76" alt="Logo" width="200" height="200">
+
+  <!-- Title -->
+  ### Persist
+
+  <!-- Description -->
+  Typescript Library to Sync Variables with LocalStorage
+
+  <!-- Repo badges -->
+  [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/persist/tags&query=$[0].name)](https://git.zakscode.com/ztimson/persist/tags)
+  [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/persist&query=open_pr_counter)](https://git.zakscode.com/ztimson/persist/pulls)
+  [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/persist&query=open_issues_count)](https://git.zakscode.com/ztimson/persist/issues)
+
+  <!-- Links -->
+
+  ---
+  <div>
+    <a href="https://git.zakscode.com/ztimson/persist/wiki" target="_blank">Documentation</a>
+    • <a href="https://git.zakscode.com/ztimson/persist/releases" target="_blank">Release Notes</a>
+    • <a href="https://git.zakscode.com/ztimson/persist/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
+    • <a href="https://git.zakscode.com/ztimson/persist/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
+  </div>
+
+  ---
+</div>
+
+## Table of Contents
+- [Persist](#top)
+	- [About](#about)
+		- [Built With](#built-with)
+	- [Setup](#setup)
+		- [Production](#production)
+		- [Development](#development)
+	- [License](#license)
+
+## About
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+### Demo
+
+Website: https://git.zakscode.com
+
+### Built With
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
+
+## Setup
+
+<details>
+<summary>
+  <h3 id="production" style="display: inline">
+    Production
+  </h3>
+</summary>
+
+#### Prerequisites
+- [Node.js](https://nodejs.org/en/download)
+
+#### Instructions
+1. Install persist: `npm i ztimson/persist`
+2. Enable decorators inside `tsconfig.json`:
+```json
+{
+	"compilerOptions": {
+		"experimentalDecorators": true,
+		...
+	},
+	...
+}
+```
+3. Use persist:
+```ts
+import {Persist, persist} from 'ztimson/persist';
+
+let theme = new Persist<string>('theme', {default: 'os'});
+theme.value = 'light'; // Any changes will be synced to localStorage['theme'];
+// You have to access/modify your data through the `value` property while using the Persist object
+
+// Or via decorator
+class Theme {
+	// We are overriding the default key to use the same localStorage as above
+	@persist({key: 'theme', default: 'os'}) current!: string;
+}
+theme = new Theme();
+console.log(theme.current); // Output: light
+theme.current = 'dark'; // You can ommit `.value` when using the decorator
+```
+</details>
+
+<details>
+<summary>
+  <h3 id="development" style="display: inline">
+    Development
+  </h3>
+</summary>
+
+#### Prerequisites
+- [Node.js](https://nodejs.org/en/download)
+
+#### Instructions
+1. Install the dependencies: `npm i`
+2. Build library & docs: `npm build`
+3. Run unit tests: `npm test`
+
+</details>
+
+## License
+
+Copyright © 2023 Zakary Timson | Available under MIT Licensing
+
+See the [license](./LICENSE) for more information.
diff --git a/package.json b/package.json
index 0570974..f960935 100644
--- a/package.json
+++ b/package.json
@@ -4,7 +4,7 @@
 	"description": "Sync variables with the local/session storage using proxy objects & decorators",
 	"repository": "https://git.zakscode.com/ztimson/persistance",
 	"author": "Zak Timson",
-	"license": "Apache 2.0",
+	"license": "MIT",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"scripts": {