Merge pull request #153 from kdeng00/v0.2

v0.2 release

Cargo.lock

@@ -840,7 +840,7 @@ dependencies = [
 
 [[package]]
 name = "icarus"
-version = "0.1.102"
+version = "0.2.0"
 dependencies = [
  "axum",
  "axum-extra",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus"
-version = "0.1.102"
+version = "0.2.0"
 edition = "2024"
 rust-version = "1.88"
 

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kun Deng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,17 +1,25 @@
+# Icarus
+Web API for the Icarus project.
 
 
-# Getting Started
-## Docker
-Make sure `icarus_auth` is located in the root of the parent directory if using docker.
+## Getting Started
+Quickest way to get started is with docker. Make sure `icarus_auth` and `songparser` repositories 
+are located in the root of the parent directory. Check the respective repositories to ensure they
+are setup correctly before configuring `Icarus`.
 
-Create a `.env` file for both projects - `icarus_auth` and `icarus` - in the root of each project.
+Copy the `.env.docker.sample` file to `.env`. Ensure that the `ROOT_DIRECTORY` variable is populated
+and exists on the docker image's filesystem. The credentials for the database doesn't need to be
+changed for development, but if deploying it, it should be modified.
 
 Build containers
 ```
-docker compose build --ssh default api auth_api
+docker compose build --ssh default
 ```
 
 Bring it up
 ```
-docker compose up -d --force-recreate api auth_api
+docker compose up -d --force-recreate
 ```
+
+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`.