vividboarder
/
abuse-the-force
mirror of https://github.com/ViViDboarder/abuse-the-force.git
2
0
Fork 0
Code Issues Releases Wiki Activity

Update Readme

This commit is contained in:
ViViDboarder 2013-04-24 14:24:51 -07:00
parent 579cb5edf4
commit a4684baab6
1 changed files with 29 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,4 +1,4 @@
AbUse the Force
Abuse the Force
===============
A tool expanding upon [Metaforce](https://github.com/ejholmes/metaforce) for deploying to
@ -6,17 +6,42 @@ multiple orgs as well as simpler setup for use as a pseudo compiler
Features
--------
* Soon...
* Store orgs config file for easy switching between deploy targets
* Familiar command sub-command interface (think git)
* Deploy single files without deploying the entire project
* [Vim plugin](https://github.com/ViViDboarder/vim-abuse-the-force)
Usage
-----
Soon...
Much like git, you initialize your project directory by adding your deploy targets first.
Once you have one set you can view the active target with `atf target`. If you want to deploy
from there you just execute one of the deploy commands.
**Simple Setup Example**
# Add production
atf target add production vividboarder@mycompany.com MY_SECURITY_TOKEN
# Deploy to production
atf deploy project
# Add a sandbox
atf target add sandbox vividboarder@mycompany.com.sandbox MY_SECURITY_TOKEN --sandbox
# Switch active targets
atf target activate sandbox
# Deploy to sandbox
atf deploy project
More advanced documentation can be found by running any of the `help` commands.
atf help
atf deploy help
atf retrieve help
atf target help
Why This Over Metaforce?
------------------------
* Vim and Sublime plugins (coming soon...)
* Command line configuration management
* Options for deploying or retrieving a sigle file
* Options for deploying or retrieving a single file
* Encrypted Passwords coming soon
Installation