Skip to content

Commit

Permalink
Update README.md etc.
Browse files Browse the repository at this point in the history
- Move contributing information to own document.
- Fixes badges.
  • Loading branch information
futhr committed Nov 24, 2014
1 parent b5dfdf5 commit fb4c972
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 37 deletions.
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ Gemfile.lock
.rvmrc
spec/dummy
tmp
.localeapp
coverage
coverage
.ruby-version
.ruby-gemset
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
46 changes: 13 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion spree_email_to_friend.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit fb4c972

Please sign in to comment.