Skip to content

Commit

Permalink
docs(): adds CI section to the generated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
blackjid committed Mar 3, 2016
1 parent 5703ce9 commit 4a7bcda
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
12 changes: 11 additions & 1 deletion lib/potassium/templates/application/assets/README.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions lib/potassium/templates/application/template.rb
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 4a7bcda

Please sign in to comment.