From 0b7a76f525bc0987fdf0c50ea023f40039159f3a Mon Sep 17 00:00:00 2001
From: ari <arikarim146@gmail.com>
Date: Mon, 2 Jan 2023 09:53:24 +0300
Subject: [PATCH] Add readme

---
 rspec/README.md       | 28 ++++++++++++++++++++++++++++
 rspec/helpers/base.rb |  2 +-
 2 files changed, 29 insertions(+), 1 deletion(-)
 create mode 100644 rspec/README.md

diff --git a/rspec/README.md b/rspec/README.md
new file mode 100644
index 0000000..3124fd9
--- /dev/null
+++ b/rspec/README.md
@@ -0,0 +1,28 @@
+## DIT RUBY TEMPLATE
+This is a template for a Rails project.
+
+## Instructions
+1. create a new rails app with the template flag like below:
+```
+rails new --api your_app_name --template www.github.com/ditkrg/ruby-template/template.rb
+
+```
+
+## Arguments
+This template by default will create a new rails app with the following:
+- postgresql
+- rspec
+- gemset
+- dotenv
+- docker
+- docker-compose
+
+* if you want to skip any of the above, you can pass the following arguments:
+```
+- postgres: --skip-postgres
+- rspec: --skip-rspec
+- gemset: --skip-gemset
+- dotenv: --skip-dotenv
+- docker: --skip-docker
+- docker-compose: --skip-docker-compose
+```
diff --git a/rspec/helpers/base.rb b/rspec/helpers/base.rb
index ed05b12..7f70ab0 100644
--- a/rspec/helpers/base.rb
+++ b/rspec/helpers/base.rb
@@ -1,6 +1,6 @@
 module Rspec
   module Helpers
-    def base_configurations
+    def rspec_base_configurations
       file 'spec/helpers/base.rb', <<~CODE
         module Helpers
           def transform_to_translation_attributes(attributes)