Sha256: b7f8e79ef4d08ba4b86cdad32f72290655790ade7f1e28710719ada78b275a5a

Contents?: true

Size: 1.38 KB

Versions: 23

Compression:

Stored size: 1.38 KB

Contents

<%= class_name %>
<%= "=" * class_name.size %>

Introduction goes here.

## Installation

1. Add this extension to your Gemfile with this line:
  ```ruby
  gem '<%= file_name %>', github: '[your-github-handle]/<%= file_name %>', branch: 'X-X-stable'
  ```

  The `branch` option is important: it must match the version of Spree you're using.
  For example, use `3-1-stable` if you're using Spree `3-1-stable` or any `3.1.x` version.

2. Install the gem using Bundler:
  ```ruby
  bundle install
  ```

3. Copy & run migrations
  ```ruby
  bundle exec rails g <%= file_name %>:install
  ```

4. Restart your server

  If your server was running, restart it so that it can find the assets properly.

## Testing

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 rake
```

When testing your applications integration with this extension you may use it's factories.
Simply add this require statement to your spec_helper:

```ruby
require '<%= file_name %>/factories'
```


## Contributing

If you'd like to contribute, please take a look at the
[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
pull request.

Copyright (c) <%= Time.now.year %> [name of extension creator], released under the New BSD License

Version data entries

23 entries across 23 versions & 1 rubygems

Version Path
spree_cmd-3.1.14 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.13 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.12 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.11 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.10 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.9 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.8 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.7 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.6 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.5 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.4 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.2.0.rc1 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.3 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.2 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.0.10 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.1 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.0 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.0.rc4 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.0.9 lib/spree_cmd/templates/extension/README.md
spree_cmd-3.1.0.rc3 lib/spree_cmd/templates/extension/README.md