Update README.md
This commit is contained in:
@@ -1,20 +1,21 @@
|
|||||||

|

|
||||||
|
|
||||||
[](https://circleci.com/gh/PostgREST/postgrest/tree/master)
|
[](https://www.patreon.com/postgrest)
|
||||||
|
[](https://www.paypal.me/postgrest)
|
||||||
<a href="https://heroku.com/deploy?template=https://github.com/PostgREST/postgrest">
|
<a href="https://heroku.com/deploy?template=https://github.com/PostgREST/postgrest">
|
||||||
<img src="https://img.shields.io/badge/%E2%86%91_Deploy_to-Heroku-7056bf.svg" alt="Deploy">
|
<img src="https://img.shields.io/badge/%E2%86%91_Deploy_to-Heroku-7056bf.svg" alt="Deploy">
|
||||||
</a>
|
</a>
|
||||||
[](https://gitter.im/begriffs/postgrest)
|
[](https://gitter.im/begriffs/postgrest)
|
||||||
[](http://postgrest.org)
|
[](http://postgrest.org)
|
||||||
[](http://hackage.haskell.org/package/postgrest)
|
|
||||||
[](https://hub.docker.com/r/postgrest/postgrest/)
|
[](https://hub.docker.com/r/postgrest/postgrest/)
|
||||||
[](https://www.patreon.com/postgrest)
|
[](https://circleci.com/gh/PostgREST/postgrest/tree/master)
|
||||||
|
[](http://hackage.haskell.org/package/postgrest)
|
||||||
|
|
||||||
PostgREST serves a fully RESTful API from any existing PostgreSQL
|
PostgREST serves a fully RESTful API from any existing PostgreSQL
|
||||||
database. It provides a cleaner, more standards-compliant, faster
|
database. It provides a cleaner, more standards-compliant, faster
|
||||||
API than you are likely to write from scratch.
|
API than you are likely to write from scratch.
|
||||||
|
|
||||||
### Usage
|
## Usage
|
||||||
|
|
||||||
1. Download the binary ([latest release](https://github.com/PostgREST/postgrest/releases/latest))
|
1. Download the binary ([latest release](https://github.com/PostgREST/postgrest/releases/latest))
|
||||||
for your platform.
|
for your platform.
|
||||||
@@ -24,7 +25,7 @@ API than you are likely to write from scratch.
|
|||||||
postgrest --help
|
postgrest --help
|
||||||
```
|
```
|
||||||
|
|
||||||
### Performance
|
## Performance
|
||||||
|
|
||||||
TLDR; subsecond response times for up to 2000 requests/sec on Heroku
|
TLDR; subsecond response times for up to 2000 requests/sec on Heroku
|
||||||
free tier. If you're used to servers written in interpreted languages
|
free tier. If you're used to servers written in interpreted languages
|
||||||
@@ -52,7 +53,7 @@ by
|
|||||||
* Using the PostgreSQL binary protocol
|
* Using the PostgreSQL binary protocol
|
||||||
* Being stateless to allow horizontal scaling
|
* Being stateless to allow horizontal scaling
|
||||||
|
|
||||||
### Security
|
## Security
|
||||||
|
|
||||||
PostgREST [handles
|
PostgREST [handles
|
||||||
authentication](http://postgrest.org/en/stable/auth.html) (via JSON Web
|
authentication](http://postgrest.org/en/stable/auth.html) (via JSON Web
|
||||||
@@ -73,7 +74,7 @@ are limited to certain templates using
|
|||||||
functions, the trigger workaround does not compromise row-level
|
functions, the trigger workaround does not compromise row-level
|
||||||
security.
|
security.
|
||||||
|
|
||||||
### Versioning
|
## Versioning
|
||||||
|
|
||||||
A robust long-lived API needs the freedom to exist in multiple
|
A robust long-lived API needs the freedom to exist in multiple
|
||||||
versions. PostgREST does versioning through database schemas. This
|
versions. PostgREST does versioning through database schemas. This
|
||||||
@@ -81,7 +82,7 @@ allows you to expose tables and views without making the app brittle.
|
|||||||
Underlying tables can be superseded and hidden behind public facing
|
Underlying tables can be superseded and hidden behind public facing
|
||||||
views.
|
views.
|
||||||
|
|
||||||
### Self-documentation
|
## Self-documentation
|
||||||
|
|
||||||
PostgREST uses the [OpenAPI](https://openapis.org/) standard to
|
PostgREST uses the [OpenAPI](https://openapis.org/) standard to
|
||||||
generate up-to-date documentation for APIs. You can use a tool like
|
generate up-to-date documentation for APIs. You can use a tool like
|
||||||
@@ -93,7 +94,7 @@ instance the number of rows returned by an endpoint is reported by -
|
|||||||
and limited with - range headers. More about
|
and limited with - range headers. More about
|
||||||
[that](http://begriffs.com/posts/2014-03-06-beyond-http-header-links.html).
|
[that](http://begriffs.com/posts/2014-03-06-beyond-http-header-links.html).
|
||||||
|
|
||||||
### Data Integrity
|
## Data Integrity
|
||||||
|
|
||||||
Rather than relying on an Object Relational Mapper and custom
|
Rather than relying on an Object Relational Mapper and custom
|
||||||
imperative coding, this system requires you put declarative constraints
|
imperative coding, this system requires you put declarative constraints
|
||||||
@@ -107,7 +108,17 @@ See examples of [PostgreSQL
|
|||||||
constraints](http://www.tutorialspoint.com/postgresql/postgresql_constraints.htm)
|
constraints](http://www.tutorialspoint.com/postgresql/postgresql_constraints.htm)
|
||||||
and the [API guide](http://postgrest.org/en/stable/api.html).
|
and the [API guide](http://postgrest.org/en/stable/api.html).
|
||||||
|
|
||||||
### Thanks
|
## Supporting development
|
||||||
|
|
||||||
|
You can help PostgREST ongoing maintenance and development by:
|
||||||
|
|
||||||
|
- Making a regular donation through Patreon https://www.patreon.com/postgrest
|
||||||
|
|
||||||
|
- Alternatively, you can make a one-time donation via Paypal https://www.paypal.me/postgrest
|
||||||
|
|
||||||
|
Every donation will be spent on making PostgREST better for the whole community.
|
||||||
|
|
||||||
|
## Thanks
|
||||||
|
|
||||||
The PostgREST organization is grateful to:
|
The PostgREST organization is grateful to:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user