From 29f4219d95fdaaadaddaa70c98ca7a31855447e1 Mon Sep 17 00:00:00 2001
From: alina sireneva <alina@tei.su>
Date: Tue, 14 Jan 2025 06:42:25 +0300
Subject: [PATCH] chore: improved readme

---
 .env.example |  4 ++++
 .gitignore   |  4 ++++
 README.md    | 39 ++++++++++++++-------------------------
 3 files changed, 22 insertions(+), 25 deletions(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..aae55d4
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,4 @@
+VITE_API_ID=
+VITE_API_HASH=
+VITE_IFRAME_URL=http://localhost:3001
+VITE_HOST_ORIGIN=http://localhost:3000
diff --git a/.gitignore b/.gitignore
index a547bf3..bc55ce9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,6 +12,10 @@ dist
 dist-ssr
 *.local
 
+.env
+.env.*
+!.env.example
+
 # Editor directories and files
 .vscode/*
 !.vscode/extensions.json
diff --git a/README.md b/README.md
index 99613fc..fc4320b 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,17 @@
-## Usage
+# mtcute repl
+
+## setting up
 
 ```bash
-$ npm install # or pnpm install or yarn install
+pnpm i
+
+cd vendor
+bash build-patched-chobitsu.sh
+cd ..
+
+cp .env.example .env
+# fill the values
+
+pnpm dev
+# then open http://localhost:3000
 ```
-
-### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm run dev`
-
-Runs the app in the development mode.<br>
-Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
-
-### `npm run build`
-
-Builds the app for production to the `dist` folder.<br>
-It correctly bundles Solid in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.<br>
-Your app is ready to be deployed!
-
-## Deployment
-
-Learn more about deploying your application with the [documentations](https://vitejs.dev/guide/static-deploy.html)