update name per rename

.gitignore

@@ -17,6 +17,6 @@ dist
 *.egg-info
 
 # virtualenv
-venv_4chan_ripper
+venv_four_chan_ripper
 
 scratch.py

README.md

@@ -1,23 +1,28 @@
-# 4chan-ripper
-[![Python 3.9+](https://upload.wikimedia.org/wikipedia/commons/4/4f/Blue_Python_3.9%2B_Shield_Badge.svg)](https://www.python.org)
+# four-chan-ripper
+[![Python 3.11+](https://upload.wikimedia.org/wikipedia/commons/6/62/Blue_Python_3.11%2B_Shield_Badge.svg)](https://www.python.org)
 [![License: GPL v3](https://upload.wikimedia.org/wikipedia/commons/8/86/GPL_v3_Blue_Badge.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
 
 Tool for ripping and saving the media files in 4chan threads.
 
+## Installation
+```bash
+pip install four-chan-ripper
+```
+
 ## Usage
 ```
-usage: 4cr [-h] [-b board_id] [-i] [-s] [--out output_directory] [urls ...]
+usage: __main__.py [-h] [-b board_id] [-i] [-s] [-o output_directory] [urls ...]
 
-4cr CLI
+4chan ripper CLI
 
 positional arguments:
-  urls                  the urls to process
+  urls                 the urls to process
 
 options:
-  -h, --help            show this help message and exit
-  -b board_id           The short id of the board to target. Ignored if the program was not started in interactive mode. Default is hr
-  -i                    Causes the archive file to get ignored. Only applicable in interactive mode.
-  -s                    Treat the input urls as a photoset to rip
-  --out output_directory
-                        The output directory. Default is ~/Public
-```
+  -h, --help           show this help message and exit
+  -b board_id          The short id of the board to target. Ignored if the program was not started in interactive mode. Default is hr
+  -i                   Causes the archive file to get ignored. Only applicable in interactive mode.
+  -s                   Treat the input urls as a photoset to rip
+  -o output_directory  The output directory. Defaults to the current working directory.
+```
+Also installs a CLI alias called `4cr` which can be used to invoke the program directly

four_chan_ripper/__main__.py

@@ -69,7 +69,7 @@ def download(self, out_dir: Path) -> bool:
 
 def _main() -> None:
     """Main driver, invoked when this file is run directly."""
-    cli_parser = ArgumentParser(description="4cr CLI")
+    cli_parser = ArgumentParser(description="4chan ripper CLI")
     cli_parser.add_argument('-b', type=str, metavar="board_id", default="hr", help="The short id of the board to target. Ignored if the program was not started in interactive mode.  Default is hr")
     cli_parser.add_argument('-i', action='store_true', help="Causes the archive file to get ignored. Only applicable in interactive mode.")
     cli_parser.add_argument('-s', action='store_true', help="Treat the input urls as a photoset to rip")

setup.py

@@ -4,16 +4,16 @@
     long_description = fh.read()
 
 setuptools.setup(
-    name="4chan-ripper",
+    name="four-chan-ripper",
     version="0.0.1",
     author="Fastily",
     author_email="fastily@users.noreply.github.com",
     description="Rips the contents of threads on 4chan",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/fastily/4chan-ripper",
+    url="https://github.com/fastily/four-chan-ripper",
     project_urls={
-        "Bug Tracker": "https://github.com/fastily/4chan-ripper/issues",
+        "Bug Tracker": "https://github.com/fastily/four-chan-ripper/issues",
     },
     include_package_data=True,
     packages=setuptools.find_packages(include=["four_chan_ripper"]),