Add README

egeakman · egeakman · commit a26b46981800 · 2023-07-25T22:44:02.000+03:00
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+# python-docs-bootstrapper
+
+This repository contains the scripts and data used to bootstrap a new translation of the Python documentation.
+
+## Installation
+
+```bash
+$ pip install python-docs-bootstrapper
+```
+
+## Usage
+
+```bash
+$ bootstrapper --help
+usage: bootstrapper [-h] [-b BRANCH] language
+
+positional arguments:
+  language              IETF language tag (e.g. tr, pt-br)
+
+options:
+  -h, --help            show this help message and exit
+  -b BRANCH, --branch BRANCH
+                        CPython branch (e.g. 3.12)
+```
+
+## Example
+
+```bash
+$ bootstrapper tr --branch 3.12
+```
