Skip to content

Commit b06154f

Browse files
committed
docs(README): add features and notes section
1 parent 71fe527 commit b06154f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
An easy, beginner-friendly [PostgreSQL](https://www.postgresql.org/) database wrapper similar to [quick.db](https://github.com/lorencerri/quick.db).
44

5+
## Features
6+
7+
- Near identical syntax to [quick.db](https://github.com/lorencerri/quick.db)
8+
- Never worry about constant database corruptions again
9+
- Fully flexible, uses [pg](https://github.com/brianc/node-postgres) internally
10+
- Relies on [ES6 promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) (`async`/`await`, `.then()`)
11+
12+
If you don't know about [quick.db](https://github.com/lorencerri/quick.db), quickpostgres also has:
13+
14+
- **Persistent storage** - all data is stored on your PostgreSQL database
15+
- **Easy to setup** - All you need is a PostgreSQL database to setup
16+
- **Beginner friendly** - Use simple syntax with dot notation
17+
- **No learning curve** - 0 learning curve if you're coming from [quick.db](https://github.com/lorencerri/quick.db) or [quickmongo](https://github.com/DevSnowflake/quickmongo)
18+
519
## Installation
620

721
You can easily install quickpostgres using your preferred package manager.
@@ -76,6 +90,11 @@ If you spot a bug or you have a feature request, please open a [GitHub issue](ht
7690

7791
If you spot a security vulnerability, please [contact me](mailto:[email protected]).
7892

93+
## Notes
94+
95+
- Some users consider [quick.db](https://github.com/lorencerri/quick.db) non-suitable in the long term, reason being it uses [SQLite](https://www.sqlite.org/index.html), and is not easily scalable. However, since quickpostgres uses [PostgreSQL](https://www.postgresql.org/), one of the best production-grade database system out there, quickpostgres is suitable for production usage, in terms of performance.
96+
- Quickpostgres is meant for beginners, and uses a JSON-feeling database. If you want to use the full advantages of [PostgreSQL](https://www.postgresql.org/), we highly recommend you switching to something else.
97+
7998
## License
8099

81100
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)

0 commit comments

Comments
 (0)