diff --git a/promotions/README.md b/promotions/README.md index e6dbc8cf792..4103f90b2c1 100644 --- a/promotions/README.md +++ b/promotions/README.md @@ -1,10 +1,8 @@ -# Solidus Friendly Promotions +# Solidus Promotions -[![CircleCI](https://circleci.com/gh/friendlycart/solidus_promotions.svg?style=shield)](https://circleci.com/gh/friendlycart/solidus_promotions) +This gem contains Solidus' recommended promotion system. It is slated to replace the promotion system in the `legacy_promotions` gem. -This extension replaces Solidus core's promotion system. It is intended as both a research project and a working alternative to how promotions work in core. - -The basic architecture is very similar to the one in core Solidus, but with a few decisive tweaks, which I'll explain in the coming sections. +The basic architecture is very similar to the legacy promotion system, but with a few decisive tweaks, which I'll explain in the coming sections. ## Architecture @@ -111,22 +109,6 @@ In the admin screen, you can set a number of attributes on your promotion: ## Development -### Testing the extension - -First bundle your dependencies, then run `bin/rake`. `bin/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 -`bin/rake extension:test_app`. - -```shell -bin/rake -``` - -To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run - -```shell -bundle exec rubocop -``` - When testing your application's integration with this extension you may use its factories. You can load Solidus core factories along with this extension's factories using this statement: @@ -134,26 +116,7 @@ You can load Solidus core factories along with this extension's factories using SolidusDevSupport::TestingSupport::Factories.load_for(SolidusPromotions::Engine) ``` -### Running the sandbox - -To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for -the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to -`sandbox/bin/rails`. - -Here's an example: - -``` -$ bin/rails server -=> Booting Puma -=> Rails 6.0.2.1 application starting in development -* Listening on tcp://127.0.0.1:3000 -Use Ctrl-C to stop -``` - -### Releasing new versions - -Please refer to the [dedicated page](https://github.com/solidusio/solidus/wiki/How-to-release-extensions) in the Solidus wiki. ## License -Copyright (c) 2023 Martin Meyerhoff, released under the New BSD License. +Copyright (c) 2024 Martin Meyerhoff, Solidus Team, released under the New BSD License.