Skip to content

Commit

Permalink
Install instructions updated in the readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ZeroCool940711 committed Feb 24, 2024
1 parent ee659a0 commit 564de5d
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,10 @@
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Sygil-Dev_whoosh-reloaded&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Sygil-Dev_whoosh-reloaded)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=Sygil-Dev_whoosh-reloaded&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=Sygil-Dev_whoosh-reloaded)


--------------------------------------

> **Notice:** This repository (**whoosh-reloaded**) is a fork and continuation of the Whoosh project.

> This fork **is actively maintained** by the Sygil-Dev Organization.
--------------------------------------
Expand Down Expand Up @@ -64,8 +62,8 @@ Installing Whoosh
If you have ``setuptools`` or ``pip`` installed, you can use ``easy_install``
or ``pip`` to download and install Whoosh automatically::

# install the old version from PyPI
$ pip install Whoosh
# Install the stable version from Pypi
$ pip install whoosh-reloaded

# Install the development version from GitHub.
$ pip install git+https://github.com/Sygil-Dev/whoosh-reloaded.git
Expand All @@ -79,6 +77,7 @@ You can check out the latest version of the source code on GitHub using git:

Contributing
============

We use pre-commit to format the code and run some checks before committing to avoid common mistakes. To install it, run the following commands:

```bash
Expand All @@ -101,7 +100,6 @@ Learning more

* File bug reports and issues at https://github.com/Sygil-Dev/whoosh-reloaded/issues


Maintainers
===========

Expand All @@ -110,4 +108,5 @@ Maintainers

Discord Server
==============

- [Sygil-Dev - Resources](https://discord.gg/H5mftKP5S9)

0 comments on commit 564de5d

Please sign in to comment.