supabase / pg_net

A PostgreSQL extension that enables asynchronous (non-blocking) HTTP/HTTPS requests with SQL
https://supabase.github.io/pg_net
Apache License 2.0
213 stars 16 forks source link

Updated Readme to reflect current features #90

Closed TheOtherBrian1 closed 1 year ago

TheOtherBrian1 commented 1 year ago

What kind of change does this PR introduce?

The documentation is dated. Some sections have not been updated in over two years. Recognizing the importance of robust and current documentation, I expanded the Readme to be comprehensive, covering all aspects of the project, including newly introduced features, such as the net.http_delete function, practical examples to guide users, and clear instructions for installation.

What is the current behavior?

Prior to this update, the Readme document provided minimal guidance. It lacked a reference to important functions such as net.http_delete and did not offer users practical examples or technical explanations.

What is the new behavior?

The revised Readme now serves as a comprehensive guide to the PG_NET extension. It includes an overview of the project, a detailed table of contents for quick navigation, and a variety of examples demonstrating the usage of the extension.