Skip to content

Commit ccfd516

Browse files
committed
docs(readme): Updated
1 parent 6751c87 commit ccfd516

File tree

1 file changed

+36
-24
lines changed

1 file changed

+36
-24
lines changed

README.md

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -278,13 +278,19 @@ In order to interact with your environment's models directly, simply type in:
278278
-h, --help output usage information
279279
-V, --version output the version number
280280
281-
Commands:
281+
Commands:
282282
283+
build - Builds production-ready code for the frontend seed
283284
downgrade - Downgrades a CleverStack implementation
284285
help - Displays this help message
285286
init <project> [backend|frontend] - Initialized a new project
287+
install <modules> - Installs a module within CleverStack
286288
generate <option> <name> - Generates a controller, service, model, etc. individually
289+
list - Lists all of the available CleverStack modules
290+
new <name> - Scaffolds into a specific directory called <name>
291+
remove <modules> - Removes a module within CleverStack
287292
repl - Starts the CleverStack REPL
293+
routes - Displays your project's routes
288294
scaffold <name> - Generates a controller, service, model, etc.
289295
search [query] - Searches for a cleverstack module
290296
setup - Installs NPM & Bower packages for each module and adds modules to bundleDependencies
@@ -326,24 +332,24 @@ Downgrades to the next version (or specified version) of the seed/module (depend
326332
327333
Commands:
328334
329-
service <name> Generates a service as <name> within /Users/jenniferhartwig/services
330-
services <names> Generates services specified with <name ...> within /Users/jenniferhartwig/services
331-
controller <name> Generates a controller as <name> within /Users/jenniferhartwig/controllers
332-
controllers <names> Generates controllers specified with <name ...> within /Users/jenniferhartwig/controllers
333-
model <name> Generates a model as <name> within /Users/jenniferhartwig/models
334-
models <names> Generates models specified with <name ...> within /Users/jenniferhartwig/models
335-
task <name> Generates a task as <name> within /Users/jenniferhartwig/tasks
336-
tasks <names> Generates tasks specified with <name ...> within /Users/jenniferhartwig/tasks
337-
view <name> Generates a view as <name> within /Users/jenniferhartwig/views
338-
views <names> Generates views specified with <name ...> within /Users/jenniferhartwig/views
339-
factory <name> Generates a factory as <name> within /Users/jenniferhartwig/factories
340-
factories <names> Generates factories specified with <name ...> within /Users/jenniferhartwig/factories
341-
service <name> Generates a service as <name> within /Users/jenniferhartwig/services
342-
services <names> Generates services specified with <name ...> within /Users/jenniferhartwig/services
343-
directive <name> Generates a directive as <name> within /Users/jenniferhartwig/directives
344-
directives <names> Generates directives specified with <name ...> within /Users/jenniferhartwig/directives
345-
test [options] <name> Generates a test t as <name> within /Users/jenniferhartwig/tests
346-
tests [options] <names> Generates test specified with <name ...> within /Users/jenniferhartwig/tests
335+
service <name> Generates a service as <name> within /Users/richardgustin/Documents/Projects/CleverStack/services
336+
services <names> Generates services specified with <name ...> within /Users/richardgustin/Documents/Projects/CleverStack/services
337+
controller <name> Generates a controller as <name> within /Users/richardgustin/Documents/Projects/CleverStack/controllers
338+
controllers <names> Generates controllers specified with <name ...> within /Users/richardgustin/Documents/Projects/CleverStack/controllers
339+
model <name> Generates a model as <name> within /Users/richardgustin/Documents/Projects/CleverStack/models
340+
models <names> Generates models specified with <name ...> within /Users/richardgustin/Documents/Projects/CleverStack/models
341+
task <name> Generates a task as <name> within /Users/richardgustin/Documents/Projects/CleverStack/tasks
342+
tasks <names> Generates tasks specified with <name ...> within /Users/richardgustin/Documents/Projects/CleverStack/tasks
343+
view <name> Generates a view as <name> within /Users/richardgustin/Documents/Projects/CleverStack/views
344+
views <names> Generates views specified with <name ...> within /Users/richardgustin/Documents/Projects/CleverStack/views
345+
factory <name> Generates a factory as <name> within /Users/richardgustin/Documents/Projects/CleverStack/factories
346+
factories <names> Generates factories specified with <name ...> within /Users/richardgustin/Documents/Projects/CleverStack/factories
347+
service <name> Generates a service as <name> within /Users/richardgustin/Documents/Projects/CleverStack/services
348+
services <names> Generates services specified with <name ...> within /Users/richardgustin/Documents/Projects/CleverStack/services
349+
directive <name> Generates a directive as <name> within /Users/richardgustin/Documents/Projects/CleverStack/directives
350+
directives <names> Generates directives specified with <name ...> within /Users/richardgustin/Documents/Projects/CleverStack/directives
351+
test [options] <name> Generates a test t as <name> within /Users/richardgustin/Documents/Projects/CleverStack/tests
352+
tests [options] <names> Generates test specified with <name ...> within /Users/richardgustin/Documents/Projects/CleverStack/tests
347353
348354
Options:
349355
@@ -367,15 +373,16 @@ Downgrades to the next version (or specified version) of the seed/module (depend
367373
368374
Commands:
369375
370-
<project> creates a new project named <project>
376+
<project> creates a new project named <project>
371377
372378
Options:
373379
374380
-h, --help output usage information
375-
-f, --force delete existing projects in your current directory /Users/jenniferhartwig
381+
-f, --force delete existing projects in your current directory /Users/richardgustin/Documents/Projects/CleverStack
376382
-v, --verbose verbose output useful for debugging
377383
-A, --allow-root allow root for bower
378384
-S, --skip-protractor skips installing protractor (Frontend only)
385+
-B, --bootstrap will run `grunt bootstrap build` as part of the setup
379386
-V, --version output the version number
380387
381388
Examples:
@@ -460,19 +467,23 @@ Creates a REPL instance within your project's environment. Useful for executing
460467
`$: NODE_ENV=local clever repl`
461468

462469
```
463-
Scanning for seed locations...
464-
Welcome to CleverStack version 0.0.2
465-
Type .commands or .help for a list of commands
470+
richards-mbp:test-jan-2015 richardgustin$ clever repl
471+
✔ Welcome to CleverStack using seed version 1.2.0-rc-2
472+
✔ Type .commands or .help for a list of commands
473+
466474
cleverstack::local> .commands
475+
467476
.commands Lists all of the REPL commands
468477
.help Alias for .commands
469478
.h Alias for .commands
470479
.modules List all of the modules within this project
471480
.models Lists all models
481+
.services Lists all services
472482
.exit Exits the CleverStack REPL
473483
.quit Alias for .exit
474484
.q Alias for .exit
475485
.history Show command history
486+
476487
cleverstack::local> .quit
477488
```
478489

@@ -531,6 +542,7 @@ cleverstack::local> .quit
531542
-h, --help output usage information
532543
-A, --allow-root allow root for bower
533544
-S, --skip-protractor skips installing protractor (Frontend only)
545+
-B, --bootstrap will run `grunt bootstrap build` as part of the setup
534546
-v, --verbose verbose output useful for debugging
535547
-V, --version output the version number
536548

0 commit comments

Comments
 (0)