Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaelcr committed Oct 25, 2023
1 parent ece088a commit 21fc1b2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Please see each tool's source directory for additional documentation

### Postgres

* Superclass for connection support and SQL transaction management using [postgres.js](https://github.com/porsager/postgres)
* Superclass for connection support and SQL transaction management using
[postgres.js](https://github.com/porsager/postgres)
* Connection helpers with automatic retry logic, using the standard postgres ENV variables
* Migration tools for migration apply and rollback using
[node-pg-migrate](https://github.com/salsita/node-pg-migrate)
Expand All @@ -47,6 +48,16 @@ gracefully on unhandled exceptions or interrupt signals.
tag, and latest commit
* Helpers to extract version info to display at runtime or on documentation

### Fastify

* API server creation with CORS, Typebox and Pino logging
* OpenAPI generator plugin with YAML and JSON exports

### Helpers

* Value conversion functions (hex strings, hashes, etc.)
* Timer tools (stopwatch, waiters, etc.)

## License

The API Toolkit Library is released under the Apache 2.0 License. See the LICENSE file for more
Expand Down
3 changes: 1 addition & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
export * from './helpers/values';
export * from './logger';
export * from './fastify';
export * from './helpers';
export * from './logger';
export * from './postgres';
export * from './server-version';
export * from './shutdown-handler';

0 comments on commit 21fc1b2

Please sign in to comment.