diff --git a/README.md b/README.md index 830a7c6..589dfab 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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). diff --git a/docs/index.md b/docs/index.md index c0518e3..0f79bbc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 @@ -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: @@ -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). diff --git a/docs/installation.md b/docs/installation.md index 5578315..63c307c 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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