Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated install instructions #72

Merged
merged 8 commits into from
Feb 24, 2024
22 changes: 22 additions & 0 deletions .github/workflows/auto-merge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Dependabot auto-merge
on: pull_request

permissions:
contents: write
pull-requests: write

jobs:
dependabot:
runs-on: ubuntu-latest
if: github.actor == 'dependabot[bot]'
steps:
- name: Dependabot metadata
id: metadata
uses: dependabot/fetch-metadata@v1
with:
github-token: "${{ secrets.GITHUB_TOKEN }}"
- name: Enable auto-merge for Dependabot PRs
run: gh pr merge --auto --merge "$PR_URL"
env:
PR_URL: ${{github.event.pull_request.html_url}}
GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
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)