Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
damienlethiec committed Feb 13, 2018
1 parent f34cbd8 commit 8572c8f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

This is the rails template I used for my Rails 5.2 projects as a freelance developer. Its goal is to allow to begin new rails application easily, with a modern and efficient configuration and with good set of defaults. The project is still very much a work in progress. So do not expect it to be 100% bug free. [Contributions][] are really welcome.
This is the rails template I used for my Rails 5.2 projects as a freelance developer. Its goal is to allow to begin new rails application easily, with a modern and efficient configuration and with good set of defaults. The project is still very much a work in progress. So do not expect it to be 100% bug free. [Contributions][], ideas and help are really welcome.

This project is inspired by the template developed by Matt Brictson. Have a look [here][] to compare both.

Expand Down Expand Up @@ -105,7 +105,7 @@ Rails generators are very lightly documented; what you’ll find is that most of

## Contributing

If you want to contribute, please have a look to the issues in this repository and pick one you are interested it. You can then clone the project and submit a pull request. We also welcome new idea and, of course, bug reports.
If you want to contribute, please have a look to the issues in this repository and pick one you are interested in. You can then clone the project and submit a pull request. We also happily welcome new idea and, of course, bug reports.

[thor]: https://github.com/erikhuda/thor
[here]: https://github.com/mattbrictson/rails-template
Expand Down
3 changes: 2 additions & 1 deletion README.md.tt
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# <%= app_name %>

This is a Rails <%= Rails::VERSION::MAJOR %> app created using [modern-rails-template][]. Please check README of the template repository to see the features available out of the box.
This is a Rails <%= Rails::VERSION::MAJOR %> app created using [modern-rails-template][]. Please check README of the template repository to see the features available out of the box. To have a look to the new features introduced by Rails 5.2 (credentials for example), check this [article][].

## How to use this project

* Use [gitflow][] for version control. More info [here].
* We advise you to use [overmind][] to launch your processes in development. You just need to run `overmind s -f Procfile.dev`. Of course, another process manager, like [foreman][], would work too.
* We advise you to deploy to [Heroku][]. Do not forget to add the [Redis] add-on.

[article]: https://evilmartians.com/chronicles/rails-5-2-active-storage-and-beyond
[modern-rails-template]: https://github.com/damienlethiec/modern-rails-template
[git-flow]: https://github.com/nvie/gitflow
[here]: http://nvie.com/posts/a-successful-git-branching-model/
Expand Down

0 comments on commit 8572c8f

Please sign in to comment.