Version bump (#59)

Reviewed-on: #59
Co-authored-by: phoenix <kundeng00@pm.me>
Co-committed-by: phoenix <kundeng00@pm.me>

Cargo.lock

@@ -749,7 +749,7 @@ dependencies = [
 
 [[package]]
 name = "icarus_auth"
-version = "0.4.3"
+version = "0.5.0"
 dependencies = [
  "argon2",
  "axum",
@@ -785,7 +785,7 @@ dependencies = [
 [[package]]
 name = "icarus_models"
 version = "0.5.6"
-source = "git+ssh://git@git.kundeng.us/phoenix/icarus_models.git?tag=v0.5.6-58-13b030bbca-111#13b030bbcabeff9c7a7593929db508dee5db6914"
+source = "git+ssh://git@git.kundeng.us/phoenix/icarus_models.git?tag=v0.5.6#2d6b550ae6721b41ecc3039799f6a5e873869077"
 dependencies = [
  "josekit",
  "rand 0.9.1",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus_auth"
-version = "0.4.3"
+version = "0.5.0"
 edition = "2024"
 rust-version = "1.88"
 
@@ -20,7 +20,7 @@ time = { version = "0.3.41", features = ["macros", "serde"] }
 josekit = { version = "0.10.3" }
 utoipa = { version = "5.4.0", features = ["axum_extras"] }
 utoipa-swagger-ui = { version = "9.0.2", features = ["axum"] }
-icarus_models = { git = "ssh://git@git.kundeng.us/phoenix/icarus_models.git", tag = "v0.5.6-58-13b030bbca-111" }
+icarus_models = { git = "ssh://git@git.kundeng.us/phoenix/icarus_models.git", tag = "v0.5.6" }
 icarus_envy = { git = "ssh://git@git.kundeng.us/phoenix/icarus_envy.git", tag = "v0.3.2" }
 
 [dev-dependencies]

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
+The easiest way to get started is through docker. This assumes that docker is already installed
-can be used with regular hosting or with docker. For the sake of getting up to speed quickly,
+on your system. Copy the `.env.docker.sample` as `.env`. Most of the data in the env file doesn't 
-Docker will be covered. Make sure docker is running and your ssh identity has been loaded.
+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`.