aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md (renamed from README.rdoc)21
1 files changed, 10 insertions, 11 deletions
diff --git a/README.rdoc b/README.md
index 8c0eed7..5c6c2cc 100644
--- a/README.rdoc
+++ b/README.md
@@ -1,22 +1,21 @@
-= pdf-calendars
-Generate pdf calendars
+# pdf-calendars
+### Generate pdf calendars
-The idea is to have multiple calendar designs
-with different formats, localized text, custom colors, etc.
-and be able to create beautiful pdfs to use on Ilustrator,
-Coreldraw, Photoshop or where you need it
------------------------------------------------------------
[![Build Status](https://api.shippable.com/projects/54fedaf45ab6cc135296cb36/badge?branchName=develop)](https://app.shippable.com/projects/54fedaf45ab6cc135296cb36/builds/latest)
-== Installation
+The idea is to have multiple calendar designs with different formats,
+localized text, custom colors, etc. and be able to create beautiful pdfs
+to use on Ilustrator, Coreldraw, Photoshop or where you need it
+
+## Installation
bundle install
-== Tests
+## Tests
Run them with
bundle exec rspec
-== Localization
+## Localization
Currently available languages are english and spanish
You can add more locales from here:
-https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale \ No newline at end of file
+https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale