From ac43732938f45307845cade764f3208b5fb7c6ae Mon Sep 17 00:00:00 2001
From: Jesse Shawl <jesse@jesse.sh>
Date: Sat, 17 Feb 2024 07:37:01 -0600
Subject: [PATCH] update documentation

---
 lib/minisign/cli.rb      | 7 ++++++-
 lib/minisign/key_pair.rb | 4 ++++
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/lib/minisign/cli.rb b/lib/minisign/cli.rb
index a704564..86c0f31 100644
--- a/lib/minisign/cli.rb
+++ b/lib/minisign/cli.rb
@@ -4,11 +4,15 @@
 
 # rubocop:disable Metrics/ModuleLength
 module Minisign
-  # The command line interface
+  # The command line interface.
+  # This module is _not_ intended for library usage and is subject to
+  # breaking changes.
   module CLI
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/CyclomaticComplexity
+
+    # Command line usage
     def self.usage
       puts 'Usage:'
       puts 'minisign -G [-f] [-p pubkey_file] [-s seckey_file] [-W]'
@@ -145,6 +149,7 @@ def self.verify(options)
 
       puts options[:Q] ? signature.trusted_comment : verification
     end
+
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
diff --git a/lib/minisign/key_pair.rb b/lib/minisign/key_pair.rb
index 81bca16..9d2607c 100644
--- a/lib/minisign/key_pair.rb
+++ b/lib/minisign/key_pair.rb
@@ -5,6 +5,10 @@ module Minisign
   class KeyPair
     include Minisign::Utils
 
+    # Create a new key pair
+    # @param password [String] The password used to encrypt the private key
+    # @example
+    #   Minisign::KeyPair.new("53cr3t P4s5w0rd")
     def initialize(password = nil)
       @password = password
       @key_id = SecureRandom.bytes(8)