README.md in brown_noser-0.1.2 vs README.md in brown_noser-0.2.0

@@ -1,39 +1,56 @@
-# TeachersPet
+# BrownNoser
 
-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/teachers_pet`. To experiment with that code, run `bin/console` for an interactive prompt.
+This tool is to help manage and inspect Git Repos used for our the Coursework at WCCCEDU.
 
-TODO: Delete this and the text above, and describe your gem
+## Major Milestones
+- Sync pull request branches locally so they can be reviewed and graded locally
+- Search all submissions to validate academnic honesty
+- Step through each submission branch and build/compile/execute the code
+- Run automated tests and fuzzy acceptance on output on each submission based on a project described _Rubric_ file
+- Provide DSL to work with compiled and web based execution
+- Integrate with Linters to verify student style to save time on pedantic comments by automating comments on student repos for teachers review.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'teachers_pet'
+gem 'brown_noser', '~> 0.1.2'
 ```
 
 And then execute:
 
     $ bundle
 
 Or install it yourself as:
 
-    $ gem install teachers_pet
+    $ gem install brown_noser
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem exposes the `pet` command
 
-## Development
+### Sync PR Branches
+Bring unmerged branches to local repo for easy viewing and searching without merging.
+```
+pet <user> <repo> -u <username> -p <password> -s
+pet <user> <repo> --username <username> --pasword <password> --sync
+```
 
-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.
+### Search for patterns in local repo (Help find cheating)
+```
+pet -f 'Your query or Regex'
+pet --find 'Your query or Regex'
+```
 
-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).
+## Development
 
+Clone and run `bundle install` to receive deps.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/teachers_pet.
+Bug reports and pull requests are welcome on GitHub at https://github.com/WCCCEDU/brown_noser.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).