git_miner 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa67e6c72b1527778f786fb604807437789516188c2b0aac1d6520701571762
-  data.tar.gz: 9323e1fcd8d7ab220b10ef465baf8a158252b7bf6f317366707f7954a69f11e3
+  metadata.gz: bd21fc17951e069e786be9eed380d7d459e62aae10e54b252cb8fe0150652ca8
+  data.tar.gz: c7ebdce6a7230d14bafb1a325eecea4671337cd04f9412708fc4dbc3fcb233f4
 SHA512:
-  metadata.gz: 6d6e3c36b03808d24f4e8ae8dafd7cec12da24d586cabc637d667ed76a5c9c446f017764a80f57a1cefd2e0ca349c61bc2eb3948cb76998c97992aaa4497218b
-  data.tar.gz: aaeef8f54d352eb93649de28f2d54f107b1ac7e5d856505660f9a7a649aa8c436062216ffaf2ca5da04771e3cd35292b9963fa620fb91213bdcd804c904e8ca6
+  metadata.gz: 703fa603e4218a04c97b90f8e2366ddada4be11080168922f482ab6658695178e010708c249b7d1e02d3a8c5f96c5e0128d07246bfb25165c3b6c0633a7fac17
+  data.tar.gz: e805cfb6aa93d88be8eb69b252433bb5b1df7dc563d24ee009a4837f5253bb9d882466be08ae7a2fe368523f9a6cc31e7d714698b7c12c611ee854070f301d8b

data/README.md

@@ -1,20 +1,20 @@
 # GitMiner
 
-Pet project I build experimenting with different concepts.
+Pet project I built to experiment with different concepts.
 
-GitMiner allow for "mining" of vanity git prefixes.
+GitMiner allow for "mining" of vanity Git sha1 prefixes.
 
 This gem is a work in progress (core functionality is working).
 
 
 ## Installation
 
-Installation will add the `git-mine` binary.
-
 ```ruby
 gem 'git_miner'
 ```
 
+The installation will add the `git-mine` binary which act as a Git custom command: `git mine`.
+
 
 ## Usage
 
@@ -25,4 +25,11 @@ Eg.:
 git mine c0ffee
 ```
 
-Some extra options are available. `git-mine -h` will display the help section (default options are optimised for performance).
+Some extra options are available (experimental):
+```
+$ git-mine -h
+Usage: example.rb [options]
+        --engine [ruby|c]            Set the engine (default: ruby)
+        --dispatch [simple|parallel] Set the dispatch (default: parallel)
+    -h, --help                       Show this message
+```

data/bin/git-mine

@@ -15,11 +15,11 @@ options = {
 OptionParser.new do |opts|
   opts.banner = "Usage: example.rb [options]"
 
-  opts.on("--engine [ruby|c]", [:ruby, :c], "Desired engine (default: ruby)") do |x|
+  opts.on("--engine [ruby|c]", [:ruby, :c], "Set the engine (default: ruby)") do |x|
     options[:engine] = x
   end
 
-  opts.on("--dispatch [simple|parallel]", [:simple, :parallel], "Desired dispatch (default: parallel)") do |x|
+  opts.on("--dispatch [simple|parallel]", [:simple, :parallel], "Set the dispatch (default: parallel)") do |x|
     options[:dispatch] = x
   end
 

data/lib/git_miner/version.rb

@@ -1,3 +1,3 @@
 module GitMiner
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_miner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Thierry Joyal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel