diff --git a/README.md b/README.md index 26ab205..6daa509 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # asyncron -A minimal async task scheduler django app! \ No newline at end of file +A minimal async task scheduler django app! + + +Add this to your gunicorn.py config: +`from asyncron.gunicorn import post_fork` + +Or run this +`python3 manage.py run_asyncron_worker` + + + +Example Django Config: +``` +ASYNCRON = { + "IMPORT_PER_APP": ["api", "tasks"], #Trys to load api.py and tasks.py files from apps inside your project +} +``` + + +Example Task in task.py: +``` +import asyncron +@asyncron.task( interval = "10m", jitter = "+10m" ) +async def keep_identity_provider_configs_fresh(): + ... +``` \ No newline at end of file