summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoger Gonzalez <roger@rogs.me>2024-03-03 18:15:42 -0300
committerRoger Gonzalez <roger@rogs.me>2024-03-03 18:15:42 -0300
commitc234fd9fdeebff8fc95cd49d62d7ad054ad28b56 (patch)
treeef35b14541862268bdd38b1fb3c2f9f2f26e56a8
parent6ff7c9750a9641a291b380c6b3a492417a05a186 (diff)
Updated README
-rw-r--r--README.md20
-rw-r--r--pyproject.toml2
2 files changed, 19 insertions, 3 deletions
diff --git a/README.md b/README.md
index ecab0c8..679d7e1 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,16 @@ Subscleaner is a Python script that removes advertisements from subtitle files.
## Installation
+### Automatic installation
+
+To install with `pip`:
+
+``` sh
+sudo pip install subscleaner
+```
+
+### Manual installation
+
To install Subscleaner, you'll need Python 3.9 or higher. It's recommended to use Poetry for managing the project dependencies.
1. Clone the repository:
@@ -32,7 +42,13 @@ poetry install
## Usage
-To use Subscleaner, you can pipe a list of subtitle filenames into the script:
+If you installed the package automatically, you can pipe a list of subtitle filenames into the script:
+
+``` sh
+find /your/media/location -name "*.srt" | subscleaner
+```
+
+If you installed the package manually:
``` sh
find /your/media/location -name "*.srt" | poetry run subscleaner
@@ -50,7 +66,7 @@ Contributions are welcome! If you have any suggestions or improvements, feel fre
## License
-Subscleaner is licensed under the GNU General Public License v3.0 or later. See the LICENSE file for more details.
+Subscleaner is licensed under the GNU General Public License v3.0 or later. See the [LICENSE](https://gitlab.com/rogs/subscleaner/-/blob/master/LICENSE) file for more details.
## Acknowledgments
diff --git a/pyproject.toml b/pyproject.toml
index bb14682..f461b3b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "subscleaner"
-version = "0.1.1"
+version = "0.1.2"
description = "Remove advertisements from subtitle files"
authors = ["Roger Gonzalez <roger@rogs.me>"]
license = "GPL-3.0-or-later"