top-beers-cli-app 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 749f5e85c631ea6b2ffc8815e9f7ef4b590347b5
4
- data.tar.gz: 8469392b300fc36bdd8d5687ec0d4379296bacd0
3
+ metadata.gz: fbf6c351aef4c562eb4f035ab8fff1e9a5763b55
4
+ data.tar.gz: fa918757fb0f03f474745c891b7c59cb2b179f4a
5
5
  SHA512:
6
- metadata.gz: 439c9bcf917c34a32183199e0bd2dcd35136c50f76acace721801a81ce73931502100d37a23098d69a7b8ef29f6aab0b2a61244a250336ee39cdd4e6bf452812
7
- data.tar.gz: f32218468e32c37f3a0592080a8450bac6dac901005dcd98265336ee1760910a7b0fd8157123188cdb5c917cc5df9053948e1c8a5fb1f1607e85ccea8ea2aa87
6
+ metadata.gz: 2f20da6a248a40ab49abed96690cf2c8b62c37b681c2e5f78e6c9e574d9dbd69f01ba05c18274cc4a2d0807958ff4e6c9dc8fa4a2a79c451d574a879d1b64982
7
+ data.tar.gz: b2d7379d8c51647e07172c3aed4b0a562d29e496fd1cc45df5b128148fb217391512d7feca8b600a02ce8ed2e51484e7aab022c89a01ff2b646a30bbae9c24aa
data/README.md CHANGED
@@ -1,38 +1,38 @@
1
1
  # TopBeers
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/top-beers`. To experiment with that code, run `bin/console` for an interactive prompt.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ TopBeers CLI App, the place to go for information on the best beers in the world! This app scrapes from Beer Advocate's Top 250 beer list and provides detailed information that can be interacted with using the command line.
6
4
 
7
5
  ## Installation
8
6
 
9
- Add this line to your application's Gemfile:
7
+ Install with:
10
8
 
11
- ```ruby
12
- gem 'top-beers'
13
- ```
9
+ $ gem install top-beers-cli-app
14
10
 
15
- And then execute:
11
+ ## Usage
16
12
 
17
- $ bundle
13
+ After installation, type the command 'top-beers' in the command line. You will be presented with a numbered list of the 25 best beers. From this menu, you can:
18
14
 
19
- Or install it yourself as:
15
+ Type a number to access detailed information about the accompanying beer
16
+ Type 'more' to see 25 more beers, up to 250
17
+ Type 'all' to see all 250 beers at once
20
18
 
21
- $ gem install top-beers
19
+ There are two other menus accessible in the TopBeers app:
20
+ 'breweries' accesses all of the breweries with beers in the top 250 list
21
+ 'styles' accesses all of the styles represented in the top 250 list
22
22
 
23
- ## Usage
23
+ Selecting a single beer/brewery/style is always done by typing the accompanying number.
24
24
 
25
- TODO: Write usage instructions here
25
+ Type 'help' from any menu to see the the complete list of commands
26
26
 
27
27
  ## Development
28
28
 
29
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
29
+ After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
30
 
31
31
  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
32
 
33
33
  ## Contributing
34
34
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/top-beers. 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.
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/BeejLuig/top-beers-cli-app. 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
36
 
37
37
 
38
38
  ## License
@@ -1,3 +1,3 @@
1
1
  module TopBeers
2
- VERSION = "0.1.3"
2
+ VERSION = "0.1.4"
3
3
  end
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
10
10
  spec.email = ["bjcantlupe@gmail.com"]
11
11
 
12
12
  spec.summary = %q{A CLI app for the world's top beers}
13
- spec.description = %q{This app scrapes from Beer Advocates website to display the world's top 250 beers. The user can interact with the CLI to learn more information about each beer, including detailed descriptions, brewery information and ABV.}
13
+ spec.description = %q{This app scrapes from Beer Advocates website to display the world's top 250 beers. The user can interact with the CLI to learn more information about each beer, including detailed descriptions, brewery information and ABV. After installing, use the command 'top-beers'}
14
14
  spec.homepage = "https://github.com/BeejLuig/top-beers-cli-app"
15
15
  spec.license = "MIT"
16
16
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: top-beers-cli-app
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - BJ Cantlupe
@@ -88,7 +88,8 @@ dependencies:
88
88
  version: '0.8'
89
89
  description: This app scrapes from Beer Advocates website to display the world's top
90
90
  250 beers. The user can interact with the CLI to learn more information about each
91
- beer, including detailed descriptions, brewery information and ABV.
91
+ beer, including detailed descriptions, brewery information and ABV. After installing,
92
+ use the command 'top-beers'
92
93
  email:
93
94
  - bjcantlupe@gmail.com
94
95
  executables: