Skip to content

Commit

Permalink
Updated README and (c) year.
Browse files Browse the repository at this point in the history
Also add badges for Travis and Code Climate.
  • Loading branch information
futhr committed Mar 26, 2014
1 parent 6e22713 commit 3107c47
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 8 deletions.
2 changes: 1 addition & 1 deletion LICENSE.md
@@ -1,7 +1,7 @@
Spree Product Assembly License
==============================

Copyright © 2007-2013, Spree Commerce Inc. and other contributors.
Copyright © 2007-2014, Spree Commerce Inc. and other contributors.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Expand Down
51 changes: 44 additions & 7 deletions README.markdown
@@ -1,12 +1,16 @@
# Product Assembly

[![Build Status](https://secure.travis-ci.org/spree/spree-product-assembly.png)](https://travis-ci.org/spree/spree-product-assembly)
[![Code Climate](https://codeclimate.com/github/spree/spree-product-assembly.png)](https://codeclimate.com/github/spree/spree-product-assembly)

Create a product which is composed of other products.

## Installation

Add the following line to your Gemfile

gem "spree_product_assembly", github: "spree/spree-product-assembly"
Add the following line to your `Gemfile`
```ruby
gem 'spree_product_assembly', github: 'spree/spree-product-assembly', branch: 'master'
```

Run bundle install as well as the extension intall command to copy and run migrations and
append spree_product_assembly to your js manifest file
Expand All @@ -25,7 +29,7 @@ exceptions. No need to run this task if you're not upgrading from product assemb

rake spree_product_assembly:upgrade

# Use
## Use

To build a bundle (assembly product) you'd need to first check the "Can be part"
flag on each product you want to be part of the bundle. Then create a product
Expand All @@ -40,6 +44,39 @@ of products.
Contributing
------------

Spree is an open source project and we encourage contributions. Please see the
[contributors guidelines](http://spreecommerce.com/documentation/contributing_to_spree.html)
before contributing.
Spree is an open source project and we encourage contributions. Please see the [contributors guidelines][1] before contributing.

In the spirit of [free software][2], **everyone** is encouraged to help improve this project.

Here are some ways *you* can contribute:

* by using prerelease versions
* by reporting [bugs][3]
* 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][3]
* 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

Copyright (c) 2014 [Spree Commerce Inc.][4] and [contributors][5], released under the [New BSD License][6]

[1]: http://guides.spreecommerce.com/developer/contributing.html
[2]: http://www.fsf.org/licensing/essays/free-sw.html
[3]: https://github.com/spree/spree-product-assembly/issues
[4]: https://github.com/spree
[5]: https://github.com/spree/spree-product-assembly/graphs/contributors
[6]: https://github.com/spree/spree-product-assembly/blob/master/LICENSE.md

0 comments on commit 3107c47

Please sign in to comment.