README.md in self_systeem-0.0.2 vs README.md in self_systeem-0.0.3
- old
+ new
@@ -1,29 +1,129 @@
-# SelfSysteem
+self_systeem
+============
+| Project | Gem Release |
+|------------------------ | ----------------- |
+| Gem name | self_systeem |
+| License | [MIT](LICENSE.txt) |
+| Version | [](http://badge.fury.io/rb/self_systeem) |
+| Continuous Integration | [](https://travis-ci.org/mfpiccolo/self_systeem)
+| Test Coverage | [](https://coveralls.io/r/mfpiccolo/self_systeem?branch=coveralls)
+| Grade | [](https://codeclimate.com/github/mfpiccolo/self_systeem)
+| Dependencies | [](https://gemnasium.com/mfpiccolo/self_systeem)
+| Homepage | [http://mfpiccolo.github.io/self_systeem][homepage] |
+| Documentation | [http://rdoc.info/github/mfpiccolo/self_systeem/frames][documentation] |
+| Issues | [https://github.com/mfpiccolo/self_systeem/issues][issues] |
-TODO: Write a gem description
+## Description
+###Definition: self-systeem
+noun
+
+1. a realistic respect for or favorable impression of one's system
+2. confidence in one's system worth or abilities
+3. system-respect
+
+Do you have low self-systeem? Don't worry. This gem is here to help.
+
+self_systeem allows you to record a users interaction with your rails app in a
+development enviornment and automatically creates system tests based on the
+recordings.
+
+It is simple. Walk through the app from sart to finish. Cover as much as you
+feel comfortable. That't it. You just built a system test. Congrats!
+
+## Features
+
+After setting up self_systeem (see configuration below) use the generator to create
+the system test directory.
+
+`rails g self_systeem:test`
+
+Then run `SELF_SYSTEEM=true rails s`
+
+Now open a new browser preferably in incognito mode so you have fresh session.
+Walk through your app like a normal user would. While you are doing this positive
+affirmations are being built in "test/system/support/systeem_booster.yml"
+
+Now just run the test file with `ruby -Itest test/system/systeem_test.rb` and watch
+you tests turn green. What does this really get you? Well for one the session and
+database is persisted while runnin all these tests. That means that when you are running
+your tests it is essentially a recreation of all of those users actions in sequence.
+
+Possitive affirmations:
+* "Today, my system choose to see love instead of fear"
+* "My system possess the qualities needed to be extremely successful"
+
+Feeling better?
+
+Well if those didn't work you can always check out the affirmations that you have built in systeem_booster.yml. That should do the trick.
+
## Installation
Add this line to your application's Gemfile:
- gem 'self_systeem'
+```ruby
+gem "self_systeem"
+```
And then execute:
$ bundle
Or install it yourself as:
$ gem install self_systeem
-## Usage
+## Configuration
-TODO: Write usage instructions here
+To use the generator run:
+ $ rails g self_systeem:test
+
+This will set up a system folder under test with a test file and some support files.
+
+Add this line to development.rb
+
+`config.middleware.use "SelfSysteem::AffirmationBuilder" if ENV["SELF_SYSTEEM"].present?`
+
+Temporarily change you database.yml so the development database uses the test database.
+This step is only while you build systeem_booster.yml file. Chage it back when you are done.
+
+i.e.
+```ruby
+ development: &dev
+ adapter: postgresql
+ encoding: unicode
+ database: app_test # Change this back after creating the
+ pool: 5
+ username: <%= ENV["USER"] %>
+ password:
+ allow_concurrency: true
+ min_messages: warning
+```
+
+## Donating
+Support this project and [others by mfpiccolo][gittip-mfpiccolo] via [gittip][gittip-mfpiccolo].
+
+[gittip-mfpiccolo]: https://www.gittip.com/mfpiccolo/
+
+## Copyright
+
+Copyright (c) 2013 Mike Piccolo
+
+See [LICENSE.txt](LICENSE.txt) for details.
+
## Contributing
1. Fork it ( http://github.com/<my-github-username>/self_systeem/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+[](http://githalytics.com/mfpiccolo/self_systeem)
+
+[license]: https://github.com/mfpiccolo/self_systeem/MIT-LICENSE
+[homepage]: http://mfpiccolo.github.io/self_systeem
+[documentation]: http://rdoc.info/github/mfpiccolo/self_systeem/frames
+[issues]: https://github.com/mfpiccolo/self_systeem/issues
+