From 6e82e10cbb22152fd45bc0b5f42be42d863b2d8f Mon Sep 17 00:00:00 2001
From: Minhyeok Park <pmh_only@pmh.codes>
Date: Tue, 12 Nov 2024 02:25:36 +0000
Subject: [PATCH] docs: add proper README.md

---
 README.md | 61 ++++++++++++-------------------------------------------
 1 file changed, 13 insertions(+), 48 deletions(-)

diff --git a/README.md b/README.md
index 74872fd..9f31abb 100644
--- a/README.md
+++ b/README.md
@@ -1,50 +1,15 @@
-# React + TypeScript + Vite
+# PTools
+A collection of tools for string conversations
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+## Demo
+* https://ptools.pmh.codes
 
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-export default tseslint.config({
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
-```
-
-- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
-- Optionally add `...tseslint.configs.stylisticTypeChecked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
-
-```js
-// eslint.config.js
-import react from 'eslint-plugin-react'
-
-export default tseslint.config({
-  // Set the react version
-  settings: { react: { version: '18.3' } },
-  plugins: {
-    // Add the react plugin
-    react,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended rules
-    ...react.configs.recommended.rules,
-    ...react.configs['jsx-runtime'].rules,
-  },
-})
-```
+## Transforms
+* Regular Expression Parser (for parsing logs)
+* Datetime Parser
+* Base64 Encoder/Decoder
+* URI Encoding Encoder/Decoder
+* JSON Beautifier/Simplifier
+* String Escaper/Unescaper
+* JSON2YAML / YAML2JSON
+* GZIP Zipped Base64 Unzipper