Skip to content

Commit 7f887d3

Browse files
committed
📝 docs(README.md): Update setup instructions and usage commands
1 parent 9eaa43f commit 7f887d3

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,27 @@ To get EggCart up and running, follow these steps:
3131
yarn install
3232
```
3333

34-
3. Create a `.env` file in the root directory and add your Telegram Bot API key and other required environment variables.
35-
36-
3.1 updated approvedShoppers function on line 114 (EggCart.js) with your process.env.user variable
34+
3. Setup your postgres environment
35+
36+
4. Create a `.env` file in the root directory and add your Telegram Bot API key and other required environment variables, like the one on `template.env`
37+
```dotenv
38+
TELEGRAM_TOKEN=1234567890:aA0bB1cC2dD3eE4fF5gG6iI7hH8jJ9kK0lL
39+
POSTGRES_HOST=localhost
40+
POSTGRES_PORT=5432
41+
POSTGRES_USERNAME=admin
42+
POSTGRES_PASSWORD=password
43+
POSTGRES_DB_NAME=database
44+
```
3745

38-
4. Start the bot:
46+
5. Start the bot:
3947
```bash
4048
yarn start
4149
```
4250

4351
## Usage
4452
Once the bot is running, you can interact with it on Telegram using the following commands:
45-
- `/add [item1, item2, ...]` - Add items to your grocery list.
46-
- `/remove [item1, item2, ...]` - Remove items from your grocery list.
53+
- `/add item1, item2, ...` - Add items to your grocery list.
54+
- `/remove item1, item2, ...` - Remove items from your grocery list.
4755
- `/list` - Display the current grocery list.
4856
- `/clear` - Clear the grocery list.
4957

0 commit comments

Comments
 (0)