Skip to content

Commit

Permalink
Documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
max-muoto committed Dec 27, 2024
1 parent d7ef3df commit 113017f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# django-pgcron

`django-pgcron` is a Django library that allows you to manage [pg_cron](https://github.com/citusdata/pg_cron) jobs from Django.

`pg_cron` is a PostgreSQL extension that allows you to schedule jobs to run inside the database on a given schedule, allowing you schedule Postgres queries without having to run them from your application.

`django-pgcron` is a Django library that enables you to manage scheduled cron jobs through Django's interface. It integrates with [`pg_cron`](https://github.com/citusdata/pg_cron), a Postgres extension that lets you schedule and automate database queries to run directly within PostgreSQL on a specified schedule, eliminating the need to execute them from your application layer.

## Quick Start

Expand Down Expand Up @@ -96,6 +93,8 @@ pip install django-pgcron

### Installing `pg_cron`

In order to use `django-pgcron`, you must have `pg_cron` installed in your database.

For instructions on installing `pg_cron`, see the [pg_cron documentation](https://github.com/citusdata/pg_cron?tab=readme-ov-file#installing-pg_cron).


Expand Down
11 changes: 8 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# django-pgcron

`django-pgcron` is a Django library that allows you to manage [pg_cron](https://github.com/citusdata/pg_cron) jobs from Django.

`pg_cron` is a PostgreSQL extension that allows you to schedule jobs to run inside the database on a given schedule, allowing you schedule Postgres queries without having to run them from your application.
`django-pgcron` is a Django library that enables you to manage scheduled cron jobs through Django's interface. It integrates with [`pg_cron`](https://github.com/citusdata/pg_cron), a Postgres extension that lets you schedule and automate datab


## Quick Start
Expand Down Expand Up @@ -85,6 +83,7 @@ python manage.py pgcron sync
This will register all of your current jobs, and drop any jobs that are no longer defined in your application. It's recommended to run this command as part of your application's deployment process alongside `migrate`.



## Installation

Install `django-pgcron` with:
Expand All @@ -93,3 +92,9 @@ Install `django-pgcron` with:
```bash
pip install django-pgcron
```

### Installing `pg_cron`

In order to use `django-pgcron`, you must have `pg_cron` installed in your database.

For instructions on installing `pg_cron`, see the [pg_cron documentation](https://github.com/citusdata/pg_cron?tab=readme-ov-file#installing-pg_cron).
3 changes: 2 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ pip install django-pgcron

### Installing `pg_cron`

For instructions on installing `pg_cron`, see the [pg_cron documentation](https://github.com/citusdata/pg_cron?tab=readme-ov-file#installing-pg_cron).
In order to use `django-pgcron`, you must have `pg_cron` installed in your database.

For instructions on installing `pg_cron`, see the [pg_cron documentation](https://github.com/citusdata/pg_cron?tab=readme-ov-file#installing-pg_cron).

## Compatibility

Expand Down

0 comments on commit 113017f

Please sign in to comment.