diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f7ac66 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +simple_oauth +============ +Simply builds and verifies OAuth headers + +Submitting a Pull Request +------------------------- +1. Fork the project. +2. Create a topic branch. +3. Implement your feature or bug fix. +4. Add documentation for your feature or bug fix. +5. Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4. +6. Add tests for your feature or bug fix. +7. Run bundle exec rake test. If your changes are not 100% covered, go back to step 6. +8. Commit and push your changes. +9. Submit a pull request. Please do not include changes to the gemspec or version file. (If you want to create your own version for some reason, please do so in a separate commit.) + +Copyright +--------- +Copyright (c) 2010 Steve Richert. See [LICENSE](https://github.com/laserlemon/simple_oauth/blob/master/LICENSE.md) for details. diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index 9830dac..0000000 --- a/README.rdoc +++ /dev/null @@ -1,17 +0,0 @@ -= simple_oauth - -Simply builds and verifies OAuth headers - -== Note on Patches/Pull Requests - -* Fork the project. -* Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with rakefile, version, or history. - (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. - -== Copyright - -Copyright (c) 2010 Steve Richert. See LICENSE for details.