Icarus-Mod-Tools 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b87da2114c2b631fc25173b50133591414801cab6098d8c42cfa630caa00573c
-  data.tar.gz: 58c4148ca81ac3f90c8fd2b19d11089bb09c310ff362df4b054f489eeaab5a2e
+  metadata.gz: daeaf600cc95360b7002385ce3c955b75ef0de606893bf5b73d34ce5d76dbba7
+  data.tar.gz: 8ca92cb968f6d7f1cd23a14fc3a393b32d8acac0ac10039b91d8265a5a8bdd9d
 SHA512:
-  metadata.gz: 7cb7ece0dc6f41bc01786927320978ebef9e6dc15d6fc28ee4512694f04c166a5094b16b9e0def5a8b72b9f59d2182e3535319a3c11b2966b7c549105ece6b87
-  data.tar.gz: 62493cc38c36c1da82176a4d8f8f53bd26bd98ee331ae122650f355fa9165a49db9d596eef1d2df6c928db6f63a5cd958e457ff03ecf711c4bbf15b4b2dbf023
+  metadata.gz: '094d0be08425875bbdc181e3a01f70b63b082e08903ab9d8da6795e0813c85102d34a0c37e37e7de4319f8ae7d37e372b37f2cb1f4a2669d873814a9c45f9211'
+  data.tar.gz: c9904e4b40ba8f8bd72818146c8edfa9c07d9150152aa087e9c2aa13292fd20425b4ef85426dada71e99ada4983ac40c347889c8c2bafef9e508bf0e1ebd2ee2

data/CHANGES.md

@@ -4,21 +4,21 @@ All notable changes to this project will be documented in this file.
 
 ## History (reverse chronological order)
 
-### v1.3.0 - 2023-02
+### v1.3 - 2023-02
 
 - First public release
 - Added sorting and filtering to the `list mods` command
 - Bugfixes
 
-### v1.2.0 - 2023-01 _[Unreleased]_
+### v1.2 - 2023-01 _[Unreleased]_
 
 - initial `sync mods` working functionality
 - Bugfixes
 
-### v1.1.0 - 2022-12 _[Unreleased]_
+### v1.1 - 2022-12 _[Unreleased]_
 
 - Initial alpha release
 
-### v1.0.0 - 2022-12 _[Unreleased]_
+### v1.0 - 2022-12 _[Unreleased]_
 
 - Development

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Icarus-Mod-Tools (1.3.0)
+    Icarus-Mod-Tools (1.3.1)
       google-cloud-firestore (~> 2.7)
       octokit (~> 6.0)
       thor (~> 1.2)

data/README.md

@@ -1,22 +1,74 @@
 # Icarus::Mod::Tools
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/icarus/mod/tools`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+a CLI tool for managing the Icarus Mods Database
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+`gem install icarus-mod-tools`
+
+To use this app, you'll need to obtain and create the following ENV environment variables:
 
-    $ bundle add icarus-mod-tools
+```sh
+export GITHUB_TOKEN=your_github_token
+export GOOGLE_APPLICATION_CREDENTIALS="path/to/your/Google-keyfile"
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+If you aren't sure how to obtain these credentials, please see:
 
-    $ gem install icarus-mod-tools
+- [Google Cloud Platform](https://cloud.google.com/docs/authentication/getting-started)
+- [GitHub](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
 
 ## Usage
 
-TODO: Write usage instructions here
+imt [options] [command]
+
+### Commands
+
+```sh
+  imt add             # Adds entries to the databases
+  imt list            # Lists the databases
+  imt sync            # Syncs the databases
+```
+
+#### `imt add`
+
+```sh
+Commands:
+  imt add help [COMMAND]  # Describe subcommands or one specific subcommand
+  imt add modinfo         # Adds an entry to 'meta/modinfo/list'
+  imt add repos           # Adds an entry to 'meta/repos/list'
+
+Options:
+  -v, [--verbose], [--no-verbose]  # Increase verbosity. May be repeated for even more verbosity.
+                                   # Default: [true]
+```
+
+#### `imt list`
+
+```sh
+Commands:
+  imt list help [COMMAND]  # Describe subcommands or one specific subcommand
+  imt list modinfo         # Displays data from 'meta/modinfo/list'
+  imt list mods            # Displays data from 'mods'
+  imt list repos           # Displays data from 'meta/repos/list'
+
+Options:
+  -v, [--verbose], [--no-verbose]  # Increase verbosity. May be repeated for even more verbosity.
+                                   # Default: [true]
+```
+
+#### `imt sync`
+
+```sh
+Commands:
+  imt sync help [COMMAND]  # Describe subcommands or one specific subcommand
+  imt sync modinfo         # Reads from 'meta/repos/list' and Syncs any modinfo files we find (github only for now)
+  imt sync mods            # Reads from 'meta/modinfo/list' and updates the 'mods' database accordingly
+
+Options:
+  -v, [--verbose], [--no-verbose]  # Increase verbosity. May be repeated for even more verbosity.
+                                   # Default: [true]
+```
 
 ## Development
 

data/icarus-mod-tools.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGES.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGES.md"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.

data/lib/icarus/mod/version.rb

@@ -2,6 +2,6 @@
 
 module Icarus
   module Mod
-    VERSION = "1.3.0"
+    VERSION = "1.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Icarus-Mod-Tools
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Donovan Young
@@ -89,7 +89,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/Donovan522/icarus-mod-tools
   source_code_uri: https://github.com/Donovan522/icarus-mod-tools
-  changelog_uri: https://github.com/Donovan522/icarus-mod-tools/CHANGES.md
+  changelog_uri: https://github.com/Donovan522/icarus-mod-tools/blob/main/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []