Skip to content

Commit cc847ea

Browse files
author
Aviv Laufer
committed
Update Readme - Added pip install
1 parent 8157deb commit cc847ea

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@
2626

2727
- [📍 Overview](#-overview)
2828
- [🧩 Features](#-features)
29+
- [🚀 Getting Started](#-getting-started)
30+
- [🔖 Prerequisites](#-prerequisites)
31+
- [📦 Installation](#-installation)
2932
</details>
3033
<hr>
3134

@@ -44,3 +47,31 @@ It supports loading configuration from files, watching for file changes, and sub
4447
- Subscribe to configuration updates from a Protoconf server
4548
- Hot Reload of configuration changes
4649
- Thread-safe access to configuration values
50+
## 🚀 Getting Started
51+
52+
### 🔖 Prerequisites
53+
54+
**Python**: `version 3.11`
55+
56+
### 📦 Installation
57+
Using pip
58+
```
59+
pip install protoconfloader
60+
```
61+
62+
Build the project from source:
63+
64+
1. Clone the client-python repository:
65+
```sh
66+
❯ git clone https://github.com/protoconf/client-python
67+
```
68+
69+
2. Navigate to the project directory:
70+
```sh
71+
cd client-python
72+
```
73+
74+
3. Install the required dependencies:
75+
```sh
76+
❯ pip install -r requirements.txt
77+
```

0 commit comments

Comments
 (0)