diff --git a/README.md b/README.md index 4fe3fe3..5d01496 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # Yawpa -TODO: Write a gem description +Yet Another Way to Parse Arguments is an argument-parsing library for Ruby. + +## Features + +- Arbitrarily nested subcommands +- Entire hierarchical option configuration can be specified in one location or option configuration can be separated by subcommand +- Options can require an arbitrary number of parameters +- Options can be defined with a range specifying the allowed number of parameters ## Installation @@ -18,7 +25,7 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +require 'yawpa' ## Contributing diff --git a/yawpa.gemspec b/yawpa.gemspec index 2fd86c5..c0cf006 100644 --- a/yawpa.gemspec +++ b/yawpa.gemspec @@ -4,8 +4,8 @@ require File.expand_path('../lib/yawpa/version', __FILE__) Gem::Specification.new do |gem| gem.authors = ["Josh Holtrop"] gem.email = ["jholtrop@gmail.com"] - gem.description = %q{TODO: Write a gem description} - gem.summary = %q{TODO: Write a gem summary} + gem.description = %q{Yet Another Way to Parse Arguments is an argument-parsing library for Ruby} + gem.summary = %q{Yet Another Way to Parse Arguments} gem.homepage = "" gem.files = `git ls-files`.split($\)