diff --git a/README.md b/README.md index d16ec58..5b9f644 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,56 @@ -SpreeQuotesManagement -===================== +#Spree Quotes Management -Introduction goes here. +Provides user's quotes management for spree. -Installation ------------- +##Features -Add spree_quotes_management to your Gemfile: + * Registered Users can create quote from home page. + * Admin can create, update, publish, un-publish, and delete quotes. + * A carousel on home page to show selected quotes. -```ruby -gem 'spree_quotes_management' -``` +##Installation -Bundle your dependencies and run the installation generator: +###Add spree_quotes_management to your Gemfile: -```shell -bundle -bundle exec rails g spree_quotes_management:install -``` + ```ruby + gem 'spree_quotes_management', github: 'vinsol-spree-contrib/spree-quotes-management' + ``` -Testing -------- +###Bundle your dependencies and run the installation generator: -First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`. + ```shell + bundle + bundle exec rails g spree_quotes_management:install + ``` -```shell -bundle -bundle exec rake -``` +##Working -When testing your applications integration with this extension you may use it's factories. -Simply add this require statement to your spec_helper: +### New Quotes by client: -```ruby -require 'spree_quotes_management/factories' -``` + 1. Logged in user can submit quote from home page, in 'How was your experience with us?' form. + 2. User can leave the 'Quoted By' field to submit quote as anonymous user. -Copyright (c) 2016 [name of extension creator], released under the New BSD License +### Admin Management Interface: + 1. Admin can view all quotes in Admin Panel -> Quotes tab. + 2. Admin can publish/un-publish quotes from there. + 3. Admin can edit any quote by clicking on Edit button. + +##Testing + + Be sure to bundle your dependencies and then create a dummy test app for the specs to run against. + + ```shell + bundle + bundle exec rake test_app + bundle exec rspec spec + ``` + +## Contributing + + 1. [Fork](https://help.github.com/articles/fork-a-repo) the project + 2. Make one or more well commented and clean commits to the repository. You can make a new branch here if you are modifying more than one part or feature. + 3. Add tests for it. This is important so I don’t break it in a future version unintentionally. + 4. Perform a [pull request](https://help.github.com/articles/using-pull-requests) in github's web interface. + +## License + Copyright (c) 2016 Vinsol, released under the New BSD License