diff --git a/README.md b/README.md index db1276e..d251e1c 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,22 @@ ## Installation +Install from PyPI (recommended): + +```bash +pip install vayuayan +``` + +Install development version from GitHub: + ```bash -pip install git+https://github.com/saketkc/vayuayan.git +pip install git+https://github.com/saketlab/vayuayan.git ``` Or install from source: ```bash -git clone https://github.com/saketkc/vayuayan.git +git clone https://github.com/saketlab/vayuayan.git cd vayuayan pip install -e . ``` diff --git a/docs/history.rst b/docs/history.rst index 7b31fc6..d7d125b 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -3,6 +3,11 @@ History Release history and changelog for vayuayan. +v0.1.1 (2025-10-11) +------------------ + +* Updated installation instructions to use PyPI as primary method + v0.1.0 (2025-10-11) ------------------ diff --git a/docs/index.rst b/docs/index.rst index 211a740..19c1dc0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,8 +11,8 @@ A Python package for fetching and analysing air quality data from multiple sourc :target: https://pypi.org/project/vayuayan/ :alt: Python versions -.. image:: https://img.shields.io/github/license/saketkc/vayuayan.svg - :target: https://github.com/saketkc/vayuayan/blob/master/LICENSE +.. image:: https://img.shields.io/github/license/saketlab/vayuayan.svg + :target: https://github.com/saketlab/vayuayan/blob/master/LICENSE :alt: License Overview diff --git a/docs/installation.rst b/docs/installation.rst index 86a9cf4..15c2214 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -4,7 +4,7 @@ Installation Requirements ------------ -vayuayan requires Python 3.7 or higher and the following packages: +vayuayan requires Python 3.9 or higher and the following packages: - requests>=2.25.0 - pandas>=1.3.0 @@ -28,11 +28,17 @@ The recommended way to install vayuayan is via pip: Development Installation ------------------------ -If you want to contribute to vayuayan or install the latest development version: +Install the latest development version from GitHub: .. code-block:: bash - git clone https://github.com/saketkc/vayuayan.git + pip install git+https://github.com/saketlab/vayuayan.git + +Or if you want to contribute to vayuayan: + +.. code-block:: bash + + git clone https://github.com/saketlab/vayuayan.git cd vayuayan pip install -e ".[dev]" diff --git a/pyproject.toml b/pyproject.toml index 52b0551..05df0a3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "vayuayan" -version = "0.1.0" +version = "0.1.1" description = "Package for fetching and analyzing air quality data from multiple sources" readme = "README.md" license = "MIT"