doc: Update the README and basic documentation.

Author: schwern

.markdownlint.json

@@ -0,0 +1,4 @@
+{
+    "MD046": false,
+    "MD013": false
+}

README.md

@@ -1,24 +1,30 @@
 # TimeRange
 
-TODO: Delete this and the text below, and describe your gem
-
-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/time_range`. To experiment with that code, run `bin/console` for an interactive prompt.
+Range over Time using time intervals without ActiveSupport.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    bundle add time_range
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    gem install time_range
 
 ## Usage
 
-TODO: Write usage instructions here
+Works just like Range with one important change; **you must call `#by` to set a time interval.**
+
+```Ruby
+require 'time_range'
+
+# Print the first day of each month of 2024.
+time_range = TimeRange
+  .new(Time.local(2024), Time.local(2025), true)
+  .by(months: 1)
+time_range.each { |time| puts time }
+```
 
 ## Development
 
@@ -28,4 +34,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/schwern/ruby-time_range.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/schwern/ruby-time_range>.

lib/time_range.rb

@@ -4,7 +4,9 @@
 require_relative 'time_range/advancer'
 require_relative 'time_range/time'
 
-# Like Range, but for Time objects.
+# Range over Time stepping by time intervals.
+#
+# Does not require ActiveSupport.
 #
 # Unlike a Range, it is necessary to call #by to say how long between
 # each step.
@@ -30,10 +32,10 @@ def initialize(first, last, exclude_last = false) # rubocop:disable Style/Option
     )
   end
 
-  # The time interval to add to step through the TimeRange.
+  # The time interval to use when iterating through the TimeRange.
   #
   # Returns the TimeRange object so you can safely chain
-  # TimeRange.new(...).by(...)
+  # time_range = TimeRange.new(...).by(...)
   #
   # Currently cannot be negative.
   #

time_range.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Michael G. Schwern"]
   spec.email = ["[email protected]"]
 
-  spec.summary = "Iterate using Time objects."
+  spec.summary = "Range over Times stepping by time intervals."
   spec.description = "Easy iterating over various periods of time."
   spec.homepage = "https://github.com/schwern/ruby-time_range"
   spec.required_ruby_version = ">= 2.7"