Version bump (#59 )

Reviewed-on: #59 Co-authored-by: phoenix <kundeng00@pm.me> Co-committed-by: phoenix <kundeng00@pm.me>
Updated Readme (#58 )
2025-08-25 18:10:30 +00:00 · 2025-08-25 18:01:11 +00:00 · 2025-08-24 23:52:29 +00:00
3 changed files with 11 additions and 5 deletions
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -749,7 +749,7 @@ dependencies = [

 [[package]]
 name = "icarus_auth"
-version = "0.4.4"
+version = "0.5.0"
 dependencies = [
 "argon2",
 "axum",
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "icarus_auth"
-version = "0.4.4"
+version = "0.5.0"
 edition = "2024"
 rust-version = "1.88"

--- a/README.md
+++ b/README.md
@@ -1,9 +1,12 @@
+A auth web API services for the Icarus project.


 # Getting Started
-Copy the `.env.sample` file to `.env` and ensure that the variables are populated. This project
-can be used with regular hosting or with docker. For the sake of getting up to speed quickly,
-Docker will be covered. Make sure docker is running and your ssh identity has been loaded.
+The easiest way to get started is through docker. This assumes that docker is already installed
+on your system. Copy the `.env.docker.sample` as `.env`. Most of the data in the env file doesn't 
+need to be modified. The `SECRET_KEY` variable should be changed since it will be used for token
+generation. The `SECRET_PASSPHASE` should also be changed when in production mode, but make sure
+the respective `passphrase` database table record exists.

 Build image
 ```
@@ -24,3 +27,6 @@ Pruning
 ```
 docker system prune -a
 ```
+
+To view the OpenAPI spec, run the project and access `/swagger-ui`. If running through docker,
+the url would be something like `http://localhost:8000/swagger-ui`.
Author	SHA1	Message	Date
phoenix	a66ab7826c	Version bump (#59 ) All checks were successful Rust Build / Check (push) Successful in 40s Details Rust Build / Rustfmt (push) Successful in 37s Details Rust Build / Clippy (push) Successful in 42s Details Rust Build / build (push) Successful in 46s Details Rust Build / Test Suite (push) Successful in 2m16s Details Reviewed-on: #59 Co-authored-by: phoenix <kundeng00@pm.me> Co-committed-by: phoenix <kundeng00@pm.me>	2025-08-25 18:10:30 +00:00
phoenix	9da068252d	Updated Readme (#58 ) All checks were successful Rust Build / Rustfmt (push) Successful in 43s Details Rust Build / Clippy (push) Successful in 39s Details Rust Build / Test Suite (push) Successful in 1m42s Details Rust Build / Check (push) Successful in 1m43s Details Rust Build / build (push) Successful in 2m39s Details Reviewed-on: #58 Co-authored-by: phoenix <kundeng00@pm.me> Co-committed-by: phoenix <kundeng00@pm.me>	2025-08-25 18:01:11 +00:00
phoenix	2ba037c393	tsk-56: API documentation (#57 ) All checks were successful Rust Build / Rustfmt (push) Successful in 41s Details Rust Build / Check (push) Successful in 43s Details Rust Build / Clippy (push) Successful in 42s Details Rust Build / build (push) Successful in 1m2s Details Rust Build / Test Suite (push) Successful in 2m2s Details Closes #56 Reviewed-on: #57 Co-authored-by: phoenix <kundeng00@pm.me> Co-committed-by: phoenix <kundeng00@pm.me>	2025-08-24 23:52:29 +00:00