diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dc30425 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.bundle/ +Gemfile.lock +pkg diff --git a/Development.md b/Development.md new file mode 100644 index 0000000..a2a4cae --- /dev/null +++ b/Development.md @@ -0,0 +1,8 @@ +## Releasing a new version + +1. To release a new version, update the version number in + `git-game.spec` and commit your changes. + +2. Run `rake release`. This will create a git tag for the version, + push git commits and tags, and push the `.gem` file to + [rubygems.org](https://rubygems.org). diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..8791f12 --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +source 'https://rubygems.org' + +# Specify your gem's dependencies in git-game.gemspec +gemspec diff --git a/README.md b/README.md index eb62f22..8069e06 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,15 @@ The goal is to get the longest streak! (It's harder than you think...) ## How do I play? -- [Download the `git-game` executable](https://github.com/jsomers/git-game/releases/tag/1.2) -- Put it somewhere on your PATH (like /usr/local/bin) +- `gem install git-game` (or perform [manual installation](#manual-installation)). - Then, in any git repository, run `git game` - (If you'd like, you can select a subset of commits, for example, `git game --after={2014-08-08}`. For more options, see [http://gitref.org/inspect/](http://gitref.org/inspect/).) +### Manual Installation + +- [Download the `git-game` executable](https://github.com/jsomers/git-game/releases/tag/1.2) +- Put it somewhere on your PATH (like /usr/local/bin) + ## Requirements - Requires Ruby >1.8 diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..2995527 --- /dev/null +++ b/Rakefile @@ -0,0 +1 @@ +require "bundler/gem_tasks" diff --git a/git-game b/bin/git-game similarity index 100% rename from git-game rename to bin/git-game diff --git a/git-game.gemspec b/git-game.gemspec new file mode 100644 index 0000000..f72de04 --- /dev/null +++ b/git-game.gemspec @@ -0,0 +1,15 @@ +# coding: utf-8 + +Gem::Specification.new do |spec| + spec.name = "git-game" + spec.version = 1.1 + spec.authors = ["jsomers"] + spec.summary = %q{The git committer guessing game!} + spec.homepage = "https://github.com/jsomers/git-game" + spec.license = "MIT" + + spec.executables = 'git-game' + + spec.add_development_dependency "bundler", "~> 1.7" + spec.add_development_dependency "rake", "~> 10.0" +end