From fb4c9728357208b2fc5a255c62387ab2d8c10edc Mon Sep 17 00:00:00 2001 From: Tobias Bohwalli Date: Sun, 23 Nov 2014 21:26:51 +0100 Subject: [PATCH] Update README.md etc. - Move contributing information to own document. - Fixes badges. --- .gitignore | 5 ++-- CONTRIBUTING.md | 29 ++++++++++++++++++++++ LICENSE.md | 2 +- README.md | 46 ++++++++++------------------------- spree_email_to_friend.gemspec | 2 +- 5 files changed, 47 insertions(+), 37 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.gitignore b/.gitignore index 7de9f46..379fdb3 100644 --- a/.gitignore +++ b/.gitignore @@ -4,5 +4,6 @@ Gemfile.lock .rvmrc spec/dummy tmp -.localeapp -coverage \ No newline at end of file +coverage +.ruby-version +.ruby-gemset diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2a8cd0f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + +In the spirit of [free software][1], **everyone** is encouraged to help improve this project. + +Here are some ways *you* can contribute: + +* by using prerelease versions +* by reporting [bugs][2] +* by suggesting new features +* by writing translations +* by writing or editing documentation +* by writing specifications +* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace) +* by refactoring code +* by resolving [issues][2] +* by reviewing patches + +Starting point: + +* Fork the repo +* Clone your repo +* Run `bundle install` +* Run `bundle exec rake test_app` to create the test application in `spec/test_app` +* Make your changes +* Ensure specs pass by running `bundle exec rspec spec` +* Submit your pull request + +[1]: http://www.fsf.org/licensing/essays/free-sw.html +[2]: https://github.com/spree/spree_email_to_friend/issues diff --git a/LICENSE.md b/LICENSE.md index db365a3..68fda64 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright (c) 2014 Jorge Calás Lozano, Roman Smirnov, Trung Lê and contributors +Copyright (c) 2009-2014 Jorge Calás Lozano, Roman Smirnov, Trung Lê and contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, diff --git a/README.md b/README.md index f4634b7..d82e65a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ -Spree Email to Friend -===================== +# Spree Email to Friend -[![Build Status](https://api.travis-ci.org/spree/spree_email_to_friend.png?branch=master)](https://api.travis-ci.org/spree/spree_email_to_friend.png) -[![Code Climate](https://codeclimate.com/github/spree/spree_email_to_friend.png)](https://codeclimate.com/github/spree/spree_email_to_friend) +[![Build Status](https://travis-ci.org/spree-contrib/spree_email_to_friend.svg?branch=master)](https://travis-ci.org/spree-contrib/spree_email_to_friend) +[![CodeClimate](https://codeclimate.com/github/spree-contrib/spree_email_to_friend/badges/gpa.svg)](https://codeclimate.com/github/spree-contrib/spree_email_to_friend) +[![Gem Version](https://badge.fury.io/rb/spree_email_to_friend.svg)](http://badge.fury.io/rb/spree_email_to_friend) The Spree Email to Friend extension enables you to send the product reference to your friend via email. -Installation ------------- +--- + +## Installation Add to your `Gemfile` ```ruby @@ -21,38 +22,17 @@ bundle install Thats all! -Contributing ------------- - -In the spirit of [free software][1], **everyone** is encouraged to help improve this project. - -Here are some ways *you* can contribute: +--- -* by using prerelease versions -* by reporting [bugs][2] -* by suggesting new features -* by writing translations -* by writing or editing documentation -* by writing specifications -* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace) -* by refactoring code -* by resolving [issues][2] -* by reviewing patches +## Contributing -Starting point: +See corresponding [contributing guidelines][1]. -* Fork the repo -* Clone your repo -* Run `bundle install` -* Run `bundle exec rake test_app` to create the test application in `spec/test_app` -* Make your changes -* Ensure specs pass by running `bundle exec rspec spec` -* Submit your pull request +--- -Copyright (c) 2014 [Jorge Calás Lozano][5], [Roman Smirnov][6], [Trung Lê][7] and other [contributors][8], released under the [New BSD License][3] +Copyright (c) 2009-2014 [Jorge Calás Lozano][5], [Roman Smirnov][6], [Trung Lê][7] and other [contributors][8], released under the [New BSD License][3] -[1]: http://www.fsf.org/licensing/essays/free-sw.html -[2]: https://github.com/spree/spree_email_to_friend/issues +[1]: https://github.com/spree/spree_email_to_friend/blob/master/CONTRIBUTING.md [3]: https://github.com/spree/spree_email_to_friend/blob/master/LICENSE.md [5]: https://github.com/calas [6]: https://github.com/romul diff --git a/spree_email_to_friend.gemspec b/spree_email_to_friend.gemspec index 4ab7a54..896de23 100755 --- a/spree_email_to_friend.gemspec +++ b/spree_email_to_friend.gemspec @@ -9,7 +9,7 @@ Gem::Specification.new do |s| s.authors = ['Jorge Calás Lozano', 'Roman Smirnov', 'Trung Lê'] s.homepage = 'https://github.com/spree/spree_email_to_friend' - s.license = %q{BSD-3} + s.license = 'BSD-3' s.files = `git ls-files`.split("\n") s.test_files = `git ls-files -- spec/*`.split("\n")