Merge pull request #2 from apainintheneck/update-readme

Update readme

README.md

@@ -1,38 +1,45 @@
 # Gemview
 
-TODO: Delete this and the text below, and describe your gem
+An unofficial CLI interface for querying information from rubygems.org.
 
-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/gemview`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Features
+- Search for gems by name
+- Find recently released gems
+- Find recently updated gems
+- Read information about gems interactively
+- Read the readme and changelog for gems
+  - Note: Supported on a best effort basis
 
 ## Installation
+TODO: Write installation instructions here
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Usage
 ```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Commands:
+  gemview info NAME             # Show gem info
+  gemview releases              # List the most recent new gem releases
+  gemview search TERM           # Search for gems
+  gemview updates               # List the most recent gem updates
+  gemview version               # Print version
 ```
 
-## Usage
+## Development
 
-TODO: Write usage instructions here
+### Testing
 
-## Development
+```console
+$ bundle exec rspec
+```
 
-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.
+### Linting
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```console
+$ bundle exec standardrb
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gemview.
+Bug reports and pull requests are welcome on GitHub at https://github.com/apainintheneck/gemview.
 
 ## License