diff --git a/app/USAGE b/app/USAGE index 721ce199b..22bfcb18d 100644 --- a/app/USAGE +++ b/app/USAGE @@ -1,5 +1,24 @@ Description: - Creates an full-stack AngularJS + Node app + Creates a Full-Stack AngularJS + Node app Example: - yo angular-fullstack + yo angular-fullstack + +Sub Generators: + + Server Side: + angular-fullstack:endpoint + + Client Side: + angular-fullstack:route + angular-fullstack:controller + angular-fullstack:filter + angular-fullstack:directive + angular-fullstack:service + angular-fullstack:provider + angular-fullstack:factory + angular-fullstack:decorator + + Deployment: + angular-fullstack:openshift + angular-fullstack:heroku diff --git a/app/generator.js b/app/generator.js index 591984d98..e120de49c 100644 --- a/app/generator.js +++ b/app/generator.js @@ -13,10 +13,15 @@ export default class Generator extends Base { this.argument('name', { type: String, required: false }); + this.option('skip-install', { + desc: 'Do not install dependencies', + type: Boolean, + defaults: false + }); + this.option('app-suffix', { desc: 'Allow a custom suffix to be added to the module name', type: String, - required: 'false', defaults: 'App' }); } diff --git a/readme.md b/readme.md index 618dea68c..dcceaeebc 100644 --- a/readme.md +++ b/readme.md @@ -84,6 +84,21 @@ Available generators: ### App Sets up a new AngularJS + Express app, generating all the boilerplate you need to get started. +Usage: +```bash +Usage: + yo angular-fullstack:app [options] [] + +Options: + -h, --help # Print the generator's options and usage + --skip-cache # Do not remember prompt answers Default: false + --skip-install # Do not install dependencies Default: false + --app-suffix # Allow a custom suffix to be added to the module name Default: App + +Arguments: + name Type: String Required: false +``` + Example: ```bash yo angular-fullstack @@ -92,6 +107,21 @@ yo angular-fullstack ### Endpoint Generates a new API endpoint. +Usage: +```bash +Usage: + yo angular-fullstack:endpoint [options] + +Options: + -h, --help # Print the generator's options and usage + --skip-cache # Do not remember prompt answers Default: false + --route # URL for the endpoint + --models # Specify which model(s) to use + --endpointDirectory # Parent directory for enpoints + +Arguments: + name Type: String Required: true +``` Example: ```bash