Updated documentation

Kota-Karthik · Nov 15, 2024 · 8e5242a · 8e5242a
1 parent e6ec35e
commit 8e5242a
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,3 @@
-
 # TwinTrim
 
 TwinTrim is a powerful and efficient tool designed to find and manage duplicate files across directories. It provides a streamlined way to scan files, identify duplicates based on their content, and remove them automatically or with user guidance, helping you save storage space and keep your file system organized.
@@ -15,6 +14,8 @@ TwinTrim is a powerful and efficient tool designed to find and manage duplicate
 	- [Examples](#examples)
 - [Dependencies](#dependencies)
 - [Installation](#installation)
+  - [From PyPI](#from-pypi)
+  - [Setup for Development](#setup-for-development)
 - [Contributing](#contributing)
 - [Code of Conduct](#code-of-conduct)
 - [License](#license)
@@ -102,6 +103,18 @@ python -m twinTrim.main <directory> [OPTIONS]
 
 ## Installation
 
+### From PyPI
+
+Install the latest release from PyPI using pip:
+
+```bash
+pip install twinTrim
+```
+
+You can find the project on [PyPI](https://pypi.org/project/twinTrim/).
+
+### Setup for Development
+
 Clone the repository and install the required dependencies using Poetry:
 
 ```bash
@@ -117,7 +130,7 @@ If you haven't installed Poetry yet, you can do so by following the instructions
 
 Contributions are welcome! Whether you have ideas for improving the internal workings of TwinTrim, such as optimizing performance or refining algorithms, or you want to enhance the user interface of the CLI tool for a better user experience, your input is valuable. Please fork the repository and submit a pull request with your improvements or new features.
 
-Please refer to the [CONTRIBUTION_GUIEDLINES.md](./CONTRIBUTION_GUIDELINES.md) for guidelines on how to contribute.
+Please refer to the [CONTRIBUTION_GUIDELINES.md](./CONTRIBUTION_GUIDELINES.md) for guidelines on how to contribute.
 
 ## Code of Conduct
 
@@ -129,6 +142,4 @@ By participating in **TwinTrim**, you agree to abide by these guidelines and hel
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
diff --git a/docs/Usage.md b/docs/Usage.md
@@ -44,6 +44,18 @@ python -m twinTrim.main <directory> [OPTIONS]
 
 ## Installation
 
+### From PyPI
+
+Install the latest release from PyPI using pip:
+
+```bash
+pip install twinTrim
+```
+
+You can find the project on [PyPI](https://pypi.org/project/twinTrim/).
+
+### Setup for Development
+
 Clone the repository and install the required dependencies using Poetry:
 
 ```bash

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "twinTrim"
-version = "0.1.1"
+version = "0.1.2"
 description = "A CLI tool to find and delete duplicate files in a directory."
 authors = ["Kota-Karthik <kotakarthik2307@gmail.com>"]
 license = "MIT"

diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 
 setup(
     name='twinTrim',  # Name of the package
-    version='0.1.1',  # Version number
+    version='0.1.2',  # Version number
     description='A CLI tool to find and delete duplicate files in a directory.',  # Short description
     long_description=open('README.md').read(),  # Readme for long description
     long_description_content_type='text/markdown',  # Type of long description
@@ -15,6 +15,7 @@
         'tqdm>=4.66.5',
         'mkdocs>=1.6.1',
         'mkdocs-material>=9.5.44',
+        'inquirer >= 3.4.0'
     ],
     extras_require={  # Optional dependencies for development
         'dev': [