Skip to content

Commit a455307

Browse files
committed
chore: Update README
1 parent 4df88ec commit a455307

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,35 @@
33
[![Documentation Status](https://readthedocs.org/projects/python-codeforces/badge/?version=latest)](https://python-codeforces.readthedocs.io/en/latest/?badge=latest)
44

55
Codeforces API wrapper for python
6+
7+
## Installation
8+
9+
#### Using `pip`
10+
11+
```shell
12+
pip install python-codeforces
13+
```
14+
15+
#### From source
16+
17+
```shell
18+
git clone https://github.com/Mukundan314/python-codeforces.git
19+
cd python-codeforces
20+
pip install .
21+
```
22+
23+
#### For Development
24+
25+
```shell
26+
git clone https://github.com/Mukundan314/python-codeforces.git
27+
cd python-codeforces
28+
pip install -e .
29+
```
30+
31+
## Documentation
32+
33+
Documentation can be found at https://python-codeforces.readthedocs.io/en/latest/
34+
35+
## License
36+
37+
See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)