Skip to content

Commit bdddf1e

Browse files
authored
[README]
1 parent 080ff41 commit bdddf1e

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,26 @@
2323

2424
## 🚀 Quickstart Guide
2525

26-
### 1️⃣ Clone the repository
26+
### 🧪 Automatic Installation (recommended)
27+
28+
Use the following command to clone and install the bot automatically:
29+
30+
```bash
31+
curl -sSL https://raw.githubusercontent.com/WizardLoop/JewishPulse/main/install.sh | bash
32+
```
33+
34+
---
35+
36+
### 🛠 Manual Setup
37+
38+
#### 1️⃣ Clone the repository
2739

2840
```bash
2941
git clone https://github.com/WizardLoop/JewishPulse.git
3042
cd JewishPulse
3143
```
3244

33-
### 2️⃣ Install dependencies
45+
#### 2️⃣ Install dependencies
3446

3547
Install PHP dependencies using Docker:
3648

@@ -40,15 +52,15 @@ make composer-install
4052

4153
This runs `composer install` inside the container.
4254

43-
### 3️⃣ Launch the bot
55+
#### 3️⃣ Launch the bot
4456

4557
```bash
4658
make up
4759
```
4860

4961
The bot will start running in the background.
5062

51-
### 🔍 View logs
63+
#### 🔍 View logs
5264

5365
```bash
5466
make logs
@@ -138,6 +150,7 @@ make cs-fix
138150
- 🔄 Persistent storage of user location
139151
- 🕍 Personalized Zmanim via Hebcal API
140152
- 🧪 Fully asynchronous using `Amp` and `MadelineProto`
153+
- ⚙️ GitHub Actions CI with: PHPUnit, PHPCS, CS-Fixer, locale checks, bot output simulation
141154

142155
---
143156

0 commit comments

Comments
 (0)