Skip to content

Commit 2af1234

Browse files
authored
docs: Update README.
* Include info about git hooks * Raise Python version
1 parent 2311cf0 commit 2af1234

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ than the official GitHub-Slack integration.
2020

2121
#### 0. Requirements:
2222

23-
- Python 3.9 or above.
23+
- Python **3.10.2** or above: [Windows](https://www.python.org/downloads/windows/), [MacOS](https://www.python.org/downloads/macos/), [Linux](https://www.linuxcapable.com/how-to-install-python-3-10-on-ubuntu-20-04/)
2424
- Git
2525

2626
#### 1. Clone this repo
@@ -57,10 +57,16 @@ $ pip install -r requirements.txt
5757
```
5858
Or, if your system contains both Python 2 and Python 3, use `pip3`.
5959

60-
#### 5. Get the environment variables from another contributor
61-
#### 6. [Download and configure ngrok](https://betterprogramming.pub/ngrok-make-your-localhost-accessible-to-anyone-333b99e44b07)
62-
#### 7. Send your generated URL to MDG org admins
63-
#### 8. Run the bot
60+
#### 5. Enable git hooks
61+
```
62+
$ pip install pre-commit
63+
$ pre-commit install
64+
```
65+
66+
#### 6. Get the environment variables from another contributor
67+
#### 7. [Download and configure ngrok](https://betterprogramming.pub/ngrok-make-your-localhost-accessible-to-anyone-333b99e44b07)
68+
#### 8. Send your generated URL to MDG org admins
69+
#### 9. Run the bot
6470

6571
```
6672
$ python main.py
@@ -79,10 +85,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
7985
<td align="center"><a href="https://github.com/srinjoyghosh-bot"><img src="https://avatars.githubusercontent.com/u/76196327?v=4?s=100" width="100px;" alt=""/><br /><sub><b>srinjoyghosh-bot</b></sub></a><br /><a href="https://github.com/mdgspace/github-slack-bot/commits?author=srinjoyghosh-bot" title="Code">💻</a></td>
8086
</tr>
8187
</table>
82-
8388
<!-- markdownlint-restore -->
8489
<!-- prettier-ignore-end -->
85-
8690
<!-- ALL-CONTRIBUTORS-LIST:END -->
8791

8892
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)