Skip to content
Browse files

adjusting README

  • Loading branch information...
1 parent 37a53e1 commit 3b26854a17b562f0bb2734b40a15183e76202d06 @asceth committed Apr 10, 2012
Showing with 22 additions and 17 deletions.
  1. +22 −17 README
View
39 README
@@ -1,8 +1,5 @@
== Set Up
-* Set up repo on eden
-
-
Required Files:
* .rvmrc
* Gemfile
@@ -11,13 +8,10 @@ Required Files:
* .git/config
* config/unicorn.rb
-=== Setting Up GitConfig
- [remote "production"]
- url = git@eden:ors/deployment.git
- push = refs/heads/master:refs/heads/production
+=== Setting up .git/config
- >> git push production # updates remote production branch without local branch
+Your .git/config should know about the remotes you will be using to deploy to the server (usually just origin) as it will pull information about the remote from your local config file
=== Setting up RVM
@@ -33,20 +27,31 @@ On your ruby servers you should create a .rvmrc in the home directory of the use
* rake
* bundler
+* unicorn
+
+ors deploy commands assume you are using unicorn for your servers.
+
+
+
+== Usage
+
+run `ors help` for a list of commands to use.
+
+=== Brief Examples
-Gemfile
+Deploying to the staging website
+ bundle exec ors deploy to staging
- group :production, :demo do
- gem 'unicorn'
- gem 'mysql2'
- gem 'dalli'
- gem 'exception_notification', :git => "git://github.com/rails/exception_notification", :branch => "master", :require => "exception_notifier"
- end
+Deploying a feature branch to the production website
+ bundle exec ors deploy origin/feature_branch
+Deploying a feature branch to the staging website
+ bundle exec ors deploy origin/feature_branch to staging
-=== Usage
+=== Notes
+* By default the environment is assumed to be production and the branch you are deploying is assumed to be origin/#{environment}.
+* You can override settings by implementing a config/deploy.yml file in your repo.
-run `ors help`

0 comments on commit 3b26854

Please sign in to comment.
Something went wrong with that request. Please try again.