README.md in bspin-0.0.2 vs README.md in bspin-0.2.0
- old
+ new
@@ -1,14 +1,16 @@
# Bspin
-TODO: Write a gem description
+This will allow a call to a bspin - a css spinner styled to sit in the middle of the page over text!
## Installation
Add this line to your application's Gemfile:
- gem 'bspin'
+```ruby
+gem 'bspin'
+```
And then execute:
$ bundle
@@ -16,14 +18,25 @@
$ gem install bspin
## Usage
-TODO: Write usage instructions here
+in your applicaion.css have:
+ *= require bspin
+ An example call is <div class='bspin'></div>
+
+## Development
+
+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.
+
+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).
+
## Contributing
-1. Fork it ( http://github.com/<my-github-username>/bspin/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
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bspin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+