oorb 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -8
  3. data/lib/oorb/version.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 4d4c56d6886474a633a18528014e016a0c88bfa7
4
- data.tar.gz: cbbeb67f11e5e5428e092388eab6191afff8979b
3
+ metadata.gz: abe5679164ceaf8216bba98d50ee584eeec3ea23
4
+ data.tar.gz: 5d4a67a162374f8481c0f4b1dc4ad84034d373d3
5
5
  SHA512:
6
- metadata.gz: 1626fb20c1d70c4ff739409e6cf552ec830eed8c978c5f779aab92da5f342f97ce6ddb662e9a99099b0aeb33069b5530629ee2bc9b4555d9652f19ca759a57de
7
- data.tar.gz: 7b57bfff41b20cade5dab841493fabdc4c31008c3e7c1043398f7d506159a4d41ad74c1482bb6c6f62e9cb0bf7c1588072eb4cc7d91e09267e750894594f95f7
6
+ metadata.gz: 0f966b3d4de1fb1a1293e2cbec3ec4893bc7b9168c6ec9427773355921343fe9c86e4e3de83793b2980bd5bd9e096f9a0001c8c26a4c2c18502b538254d29e8f
7
+ data.tar.gz: 37fa54deb7aba164c09d026c539f005ce681ccbaa1c4e4fdf60ddccea9ccaab81a507abf3ee7c5e0d5bdcf9a8d210a567fcc08b8caedd93372bbb232deeac2ba
data/README.md CHANGED
@@ -1,10 +1,21 @@
1
1
  # Oorb
2
2
 
3
- 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/oorb`. To experiment with that code, run `bin/console` for an interactive prompt.
3
+ OCR Optimized Regex Builder is a command line tool for taking user input and converting it to regular expressions optimized for capturing characters that are commonly mistaken by optical character recognition engines.
4
4
 
5
- TODO: Delete this and the text above, and describe your gem
5
+ ## Installation as a command line appliction
6
6
 
7
- ## Installation
7
+ Clone this repository
8
+
9
+ $ git clone https://github.com/Calvyn82/oorb
10
+
11
+ Navigate to the root directory, run the test suite, and install the application.
12
+
13
+ $ cd oorb
14
+ $ bundle install
15
+ $ bundle exec rake
16
+ $ bundle exec rake install
17
+
18
+ ## Installation as part of a Ruby application
8
19
 
9
20
  Add this line to your application's Gemfile:
10
21
 
@@ -20,22 +31,23 @@ Or install it yourself as:
20
31
 
21
32
  $ gem install oorb
22
33
 
23
- ## Usage
34
+ ## Usage as a command line application
24
35
 
25
- TODO: Write usage instructions here
36
+ $ oorb
37
+
38
+ To exit the application, use Ctrl-c.
26
39
 
27
40
  ## Development
28
41
 
29
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
42
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake`, `bin/rake test`, `bundle exec rake` or `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
43
 
31
44
  To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
45
 
33
46
  ## Contributing
34
47
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/oorb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
48
+ Bug reports and pull requests are welcome on GitHub at https://github.com/Calvyn82/oorb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
36
49
 
37
50
 
38
51
  ## License
39
52
 
40
53
  The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
-
data/lib/oorb/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Oorb
2
- VERSION = "0.1.1"
2
+ VERSION = "0.1.2"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: oorb
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Calvyn82