From 97cad81c355ba5ae3d4a232f55ebbed70ad2fc23 Mon Sep 17 00:00:00 2001
From: thematdev <thematdev@thematdev.org>
Date: Tue, 24 Jan 2023 21:39:47 +0300
Subject: [PATCH] Added README.md

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..628afbd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+## Codeforces Scraper
+
+Codeforces scraper provides a gentle way to interact with Codeforces
+
+```
+from codeforces_scraper import Scraper
+from codeforces_scraper.languages import some_compiler_by_ext
+from getpass import getpass
+
+# Submits my code for problem 4A from your account 
+scraper = Scraper()
+username = input()
+password = getpass()
+scraper.login(username, password)
+scraper.submit(4, 'A', scraper.get_submission_source(4, 190069788), some_compiler_by_ext('.cpp'))
+```
+
+## Installation
+### From PyPi
+`pip3 install codeforces_scraper`
+
+### From sources
+
+```
+git clone https://github.com/thematdev/codeforces_scraper.git
+python3 setup.py install
+```
+
+## Reference
+A comment provided for each function.