Merge pull request #8 from Kelocker/official-v1.0.0-release

Official v1.0.0 release

Author: Kelocker

README.md

@@ -108,11 +108,11 @@ We are thrilled to announce that we are contributing to the global environment.
 ## Venvat Global
 
 <p align="center">
-  <img src="https://drive.google.com/uc?id=1Novbu8DEG1GoGINQK5pb19I2yGD40TzJ" alt="venvat-global-beta-version"/>
+  <img src="https://drive.google.com/uc?id=15e8BQvMFsyY1c-AM3S1vnUWQI8GI4u-7" alt="venvat-global-officials-version"/>
 </p>
 
 <p align="center">
-  <img src="https://drive.google.com/uc?id=1zH_oh-zisr8uPaBiFqWIta_M2UxnRb74" alt="global-venvat-beta-version now available for Linux and macOS"/>
+  <img src="https://drive.google.com/uc?id=1zH_oh-zisr8uPaBiFqWIta_M2UxnRb74" alt="global-venvat-officials-version now available for Linux and macOS"/>
 </p>
 
 ---
@@ -161,17 +161,19 @@ pip install venvat
 
 ## Activating Your Virtual Environment
 
-Once `venvat` is installed, you can easily activate your virtual environment. If you're using `venvat` for the first time or if you want to switch to a different virtual environment, you need to specify the name of your virtual environment.
+Once `venvat` is installed, you can easily activate your virtual environment.
 
 If your virtual environment is named `venv`, you can run:
 
 ```
 venvat
 ```
 
+*Important* : Venvat recognise `venv` as default name of the virtual environment
+
 ### Specifying a Custom Virtual Environment
 
-If your virtual environment is not named `venv`, you will need to configure it the first time you use `venvat`:
+If your virtual environment is not named `venv`, you will need to configure it for the first time:
 
 ```
 venvat --venv your-env-name
@@ -220,9 +222,7 @@ source ~/.zshrc
 
 Restart your terminal to apply the changes.
 
-Now, `venvat
-
-` is available globally.
+Now, `venvat` is available globally.
 
 *Optional* To uninstall `venvat` package, run:
 

SECURITY.md

@@ -6,7 +6,9 @@ The following versions of our project are currently supported with security upda
 
 | Version | Supported          |
 | ------- | ------------------ |
-| < 1.0   | :white_check_mark: |
+| ≥ 1.0   | :white_check_mark: |
+| < 1.0   | :x:                |
+
 
 
 ## Reporting a Vulnerability

VERSION

@@ -1 +1 @@
-0.3.23
+1.0.0

docs/setup.md

@@ -1,12 +1,118 @@
 # Setup Guide
 
-## Prerequisites
+## Table of content
+1. [Installation for Venvat (Windows only)](#installation-for-venvat-windows-only)
+    - [Requirements](#requirements)
+    - [Installing Python](#installing-python)
+    - [Installing pip](#installing-pip)
+    - [Installing venvat](#installing-venvat)
+    - [Activating Your Virtual Environment](#activating-your-virtual-environment)
+    - [Specifying a Custom Virtual Environment](#specifying-a-custom-virtual-environment)
+2. [Installation for Venvat Global (Linux and macOS)](#installation-for-venvat-global-linux-and-macos)
+3. [Clone repository](#Clone-repository)
 
-- Python 3.6 or later
-- pip package manager
 
 ## Installation
+## Installation for Venvat (Windows only)
 
+### Requirements
+
+Before using **venvat**, ensure the following requirements are met:
+- **Python**: This tool requires Python 3.6 or newer. Install Python from [the official website](https://www.python.org/downloads/).
+- **Virtual Environment**: You should have a virtual environment already set up in your project. `venvat` is designed to activate these environments, not to create them.
+
+### Installing Python
+
+If you need to install Python, you can download it from the official site:
+
+[https://www.python.org/downloads](https://www.python.org/downloads)
+
+### Installing pip
+
+If `pip` is not installed, you can install it by downloading `get-pip.py`:
+
+```
+curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
+python get-pip.py
+```
+
+### Installing venvat
+
+To install `venvat`, run the following command:
+
+```
+pip install venvat
+```
+
+---
+
+## Activating Your Virtual Environment
+
+Once `venvat` is installed, you can easily activate your virtual environment.
+
+If your virtual environment is named `venv`, you can run:
+
+```
+venvat
+```
+
+*Important* : Venvat recognise `venv` as default name of the virtual environment
+
+### Specifying a Custom Virtual Environment
+
+If your virtual environment is not named `venv`, you will need to configure it for the first time:
+
+```
+venvat --venv your-env-name
+```
+
+Resetting your configuration:
+
+```
+venvat --reset
+```
+
+For more features, you can explore with:
+
+```
+venvat --help
+```
+
+---
+
+## Installation for Venvat Global (Linux and macOS)
+
+### Requirements
+
+- **Python**: You need Python 3.6 or newer. Install it from [the official website](https://www.python.org/downloads/).
+- **pip**: Ensure `pip` is installed. You can follow the same pip installation process as described earlier.
+
+### Installing Venvat Global
+
+To install `venvat` globally, run:
+
+```
+pip install venvat
+```
+
+Then, activate it based on your shell:
+
+For Bash:
+```
+source ~/.bashrc
+```
+
+For Zsh:
+```
+source ~/.zshrc
+```
+
+Restart your terminal to apply the changes.
+
+Now, `venvat` is available globally.
+
+
+## Clone repository
 1. Clone the repository:
    ```
    git clone https://github.com/Kelocker/venvat.git

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='venvat',
-    version='0.3.23',
+    version='1.0.0',
     description='A script to activate Python virtual environments.',
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',