diff --git a/lib/potassium/templates/application/assets/README.md.erb b/lib/potassium/templates/application/assets/README.md.erb index 22d25934..4191faf1 100644 --- a/lib/potassium/templates/application/assets/README.md.erb +++ b/lib/potassium/templates/application/assets/README.md.erb @@ -13,8 +13,8 @@ Assuming you've just cloned the repo: ## External services TODO: add external services here -## Deployment <% if selected?(:heroku) %> +## Deployment This project is pre-configured to be (easily) deployed to Heroku servers, but needs you to have the Potassium binary installed. If you don't, then run: ```shell $ gem install potassium @@ -43,6 +43,16 @@ Remember to connect each stage to the corresponding branch: 2. Production -> Production That's it. You should already have a running app and each time you push to the corresponding branch, the system will (hopefully) update accordingly. + +## Continuous Integrations + +The project is setup to run tests +in [CircleCI](https://circleci.com/gh/platanus/<%= get(:dasherized_app_name)%>/tree/master) + +You can also run the test locally simulating the production environment using docker. +Just make sure you have docker installed and run: + + bin/cibuild <% end-%> ## Internal dependencies diff --git a/lib/potassium/templates/application/template.rb b/lib/potassium/templates/application/template.rb index e09bd5c9..a2827be7 100644 --- a/lib/potassium/templates/application/template.rb +++ b/lib/potassium/templates/application/template.rb @@ -1,6 +1,7 @@ set :app_name, @app_name set :titleized_app_name, get(:app_name).titleize set :underscorized_app_name, get(:app_name).underscore +set :dasherized_app_name, get(:app_name).dasherize run_action(:cleaning) do clean_gemfile