Skip to content

Commit 16c5b27

Browse files
committed
Update README
1 parent 003263f commit 16c5b27

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,35 @@ This repository contains code snippets demonstrating usage of the
1515
## Snippets execution settings
1616
When executing a snippet, you will need to provide some information about your Sinch account (credentials, Sinch virtual phone number, ...)
1717

18-
This setting can be placed directly in the snippet source, or you can use an [environment file](.env.example), in which case the settings will be shared and used automatically by every snippet.
19-
Rename the `.env.example` file to `.env` and fill in the required values:
18+
These settings can be placed directly in the snippet source code, **or** you can use an environment file (`.env`). Using an environment file allows the settings to be shared and used automatically by every snippet.
2019

20+
### Setting Up Your Environment File
21+
22+
#### 1. Rename the example file
23+
24+
**Linux / Mac:**
2125
```bash
2226
cp .env.example .env
2327
```
2428

25-
Install dependencies using Poetry:
29+
**Windows (Command Prompt):**
30+
```cmd
31+
copy .env.example .env
32+
```
33+
34+
Windows (PowerShell):
35+
```powershell
36+
Copy-Item .env.example .env
37+
```
38+
39+
#### 2. Fill in your credentials
40+
41+
Open the newly created [.env](.env) file in your preferred text editor and fill in the required values (e.g., SINCH_PROJECT_ID=your_project_id).
42+
43+
Note: Do not share your .env file or credentials publicly.
44+
45+
46+
### Install dependencies using Poetry:
2647

2748
```bash
2849
poetry install

0 commit comments

Comments
 (0)