Skip to content

docs: Update README.md and fix bad link in CHANGELOG.md #5

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 5, 2024
Merged

docs: Update README.md and fix bad link in CHANGELOG.md #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4676eec
Fix bad link in CHANGELOG
bgrant Feb 5, 2024
0d7faa9
Update README
bgrant Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.2] - 2024-02-05
- [PR 2](https://github.com/salesforce/django-request-queue-timeout/pull/2) Update publish-release.yml
- [PR 4](https://github.com/salesforce/django-request-queue-timeout/pull/4) Update publish-release.yml

## [1.0.1] - 2024-02-05
- [PR 1](https://github.com/salesforce/django-request-queue-timeout/pull/1) Set up Dependabot, PR checks, and a CHANGELOG
Expand Down
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,21 @@ This is useful in environments like Heroku, where traffic spikes can result in r

## Requirements

* Python >= 3.6
* Django >= 2.2
Recent versions of Python and Django. See `pyproject.toml` for exact versions.

## Installation

Install from git

pip install git+<git address>#egg=django-request-queue-timeout
```sh
pip install git+<git address>#egg=django-request-queue-timeout
```

Install from [PyPI](https://pypi.org/)
Install from [PyPI](https://pypi.org/project/django-request-queue-timeout/)

pip install django-request-queue-timeout # Not yet published to PyPI
```sh
pip install django-request-queue-timeout
```

Add to `MIDDLEWARE` list in settings file as the first item:

Expand Down