From 7f17da57b2412309ff4588af3efc31012808a426 Mon Sep 17 00:00:00 2001 From: "Barry vd. Heuvel" Date: Mon, 24 Jun 2013 14:51:08 +0200 Subject: [PATCH] Update readme --- readme.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index 838249b..febaf51 100644 --- a/readme.md +++ b/readme.md @@ -54,9 +54,9 @@ If you don't want to write your properties yourself, you can use the command `id phpDocs, based on table columns, relations and getters/setters. Still in beta, so please provide feedback if you want. Docs are written to a phpfile (_ide_helper_models.php) in the root of the project, so you can move the docs to the real model. -You can now also write the comments directly to your Model file, using the --write (-W) option. Please make sure to backup your models, before writing the info. +You can now also write the comments directly to your Model file, using the `--write (-W)` option. Please make sure to backup your models, before writing the info. It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found. -With the --reset (-R) option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs. +With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs. php artisan ide-helper:models Post @@ -74,10 +74,10 @@ With the --reset (-R) option, the existing phpdocs are ignored, only the newly f */ For now, only models in app/models are scanned. The optional argument tells what models to use (also outside app/models). -`php artisan ide-helper:models Post,User` -Note: With namespaces, uses \\ instead of \ -`php artisan ide-helper:models API\\User` + php artisan ide-helper:models Post,User + +Note: With namespaces, uses `\\` instead of `\`: `php artisan ide-helper:models API\\User` ### License