Skip to content

Commit c0d153b

Browse files
committed
adding Examples to the ./src/lib.rs that points to the ./examples/server.rs for rust doc users
1 parent 44681cb commit c0d153b

3 files changed

Lines changed: 7 additions & 1 deletion

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
target
22
./docker/db/data-pgadmin
33
./docker/db/data-postgres
4+
*.swo
5+
*.swp

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
//!
33
//! A secure-by-default rest api stack implemented with hyper, tokio, bb8 and postgres. This project is focused on providing end-to-end encryption by default for 12-factor applications looking to customize functionality using environment variables as needed. Includes a working user management and authentication backend written in postgresql with async S3 uploading for POST-ed data files.
44
//!
5+
//! # Examples
6+
//!
7+
//! Please see the [restapi/examples/server.rs](https://github.com/jay-johnson/restapi/blob/main/examples/server.rs) for developing your own rest api.
8+
//!
59
//! ### Overview
610
//!
711
//! - User authentication enabled by default and implemented with custom tls assets to encrypt all JWT tokens with storage in postgres.

0 commit comments

Comments
 (0)