diff --git a/README.md b/README.md index 2f0b3be..658342b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # Mongify::Mongoid Mongoify-Mongoid generates valid Mongoid Models from the Mongify translation file. @@ -10,9 +12,10 @@ Learn more about [Mongify](http://mongify.com/) ## Usage - mongify_mongoid translation_file.rb [--output ~/output_dir] + mongify_mongoid translation_file.rb [--output DIR] [--force] - *default output dir is the current_directory/models* + * default output dir is `models` in the current directory + * use `--force` or `-F` to overwrite an existing output directory ## Contributing @@ -54,4 +57,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.