From 8728d5954d8ba2b865961531759d42fc22668b49 Mon Sep 17 00:00:00 2001
From: Aiden Fujiwara <106630142+afujiwara-roblox@users.noreply.github.com>
Date: Wed, 1 May 2024 15:56:14 -0700
Subject: [PATCH] Add readme to artiaa_auth and bump foreman version (#96)

This PR looks to add readme to artiaa_auth so we can publish it as an
individual crate for Foreman to depend on
---
 Cargo.lock                        |  2 +-
 Cargo.toml                        |  2 +-
 artiaa_auth/README.md             | 35 +++++++++++++++++++++++++++++++
 tests/snapshots/help_command.snap |  2 +-
 4 files changed, 38 insertions(+), 3 deletions(-)
 create mode 100644 artiaa_auth/README.md

diff --git a/Cargo.lock b/Cargo.lock
index 4357d5c..b3a8e21 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -390,7 +390,7 @@ checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b"
 
 [[package]]
 name = "foreman"
-version = "1.6.2"
+version = "1.6.3"
 dependencies = [
  "artiaa_auth",
  "assert_cmd",
diff --git a/Cargo.toml b/Cargo.toml
index f57409c..996492c 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -6,7 +6,7 @@ default-members = [".", "artiaa_auth"]
 [package]
 name = "foreman"
 description = "Toolchain manager for simple binary tools"
-version = "1.6.2"
+version = "1.6.3"
 authors = [
     "Lucien Greathouse <me@lpghatguy.com>",
     "Matt Hargett <plaztiksyke@gmail.com>",
diff --git a/artiaa_auth/README.md b/artiaa_auth/README.md
new file mode 100644
index 0000000..5aaf217
--- /dev/null
+++ b/artiaa_auth/README.md
@@ -0,0 +1,35 @@
+# artiaa_auth
+Reads artifactory authentication using the following schema:
+
+```
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "type": "object",
+  "title": "ArtiAA Token File Format",
+  "description": "This is the format of the ArtiAA Token File, a standard output that contains the Artifactory tokens for the user. ",
+  "properties": {
+    "tokens": {
+      "title": "Tokens URL Map",
+      "description": "Map of URLs and the credentials that apply to them.\nThe key of each value is the base domain URL the credential applies to, such as 'artifactory.rbx.com'.\nArtiAA will add an entry for each URL it has been logged into.",
+      "type": "object",
+      "additionalProperties": {
+        "title": "URL Token Element",
+        "type": "object",
+        "properties": {
+          "username": {
+            "title": "Username",
+            "description": "The username to use for accessing the server, if a username is necessary.\nMay be an empty string.",
+            "type": "string"
+          },
+          "token": {
+            "title": "Token",
+            "description": "The token to use for accessing the server.",
+            "type": "string"
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  }
+}
+```
\ No newline at end of file
diff --git a/tests/snapshots/help_command.snap b/tests/snapshots/help_command.snap
index 98c7414..fd99e8e 100644
--- a/tests/snapshots/help_command.snap
+++ b/tests/snapshots/help_command.snap
@@ -3,7 +3,7 @@ source: tests/cli.rs
 assertion_line: 100
 expression: content
 ---
-foreman 1.6.2
+foreman 1.6.3
 
 USAGE:
     foreman [FLAGS] <SUBCOMMAND>