From a07daa9bf247277b1d3aa29c8ae8c5fde2c973e1 Mon Sep 17 00:00:00 2001
From: Terra <66390426+Terracrow@users.noreply.github.com>
Date: Fri, 13 Sep 2024 15:33:12 +0200
Subject: [PATCH] add git page
---
page/index.html | 12 ++++++++
page/index.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++
page/style.css | 0
3 files changed, 89 insertions(+)
create mode 100644 page/index.html
create mode 100644 page/index.md
create mode 100644 page/style.css
diff --git a/page/index.html b/page/index.html
new file mode 100644
index 0000000..bdf2764
--- /dev/null
+++ b/page/index.html
@@ -0,0 +1,12 @@
+
+
+
+
+ TML
+
+
+
+
+
+
+
diff --git a/page/index.md b/page/index.md
new file mode 100644
index 0000000..3e08b05
--- /dev/null
+++ b/page/index.md
@@ -0,0 +1,77 @@
+## TML: Simple-use YAML data storage
+
+> TML is a easy to use package for data manipulation
+
+- **Docs** [docs](https://terracrow.github.io/tml)
+- **NPM** [npm](https://npmjs.com/tml-db)
+
+### Installation
+```sh
+# npm
+npm install --save tml-db
+
+# yarn
+yarn add tml-db
+
+# clone source code
+git clone https://github.com/Terracrow/tml.git
+```
+
+### Examples
+> Initialize and set a value in a key
+
+```typescript
+// #test.js
+
+// import TMLDriver
+import { TMLDriver } from 'tml';
+
+// data to be stored
+const data = [
+ {
+ id: 1234,
+ allowed: true
+ },
+ {
+ id: 2341,
+ allowed: false
+ }
+];
+
+// create a database connection
+const tml = new TMLDriver({
+ limit: 100 // number of files allowed
+ customDir: 'tml' // set custom output path or put 'tml'
+});
+
+// set 'data[]' in 'access_perms.yml'
+tml.set({
+ key: 'access_perms',
+ value: data
+});
+
+
+/** Output (access_perms.yml)
+ * ---
+- id: 1234
+ allowed: true
+- id: 2341
+ allowed: false
+*/
+```
+
+> Get or delete data
+```typescript
+// #test.js
+
+// get the value of a key
+const usersPerms = db.get('access_perms');
+
+// delete data
+db.delete('access_perms');
+```
+
+---
+***This project is not finished and can present some bugs.***
+
+>Made by Terracrow | 1.0.0
diff --git a/page/style.css b/page/style.css
new file mode 100644
index 0000000..e69de29