Permalink
Browse files

Adding usage examples and listing of commands for contributors. This …

…is considered basic getting started docs until the proper docs are ready.
  • Loading branch information...
1 parent 1d7405f commit f1f903c9ae9f531ca82e79246aec09fe6dcd2203 @addyosmani addyosmani committed Aug 1, 2012
Showing with 44 additions and 4 deletions.
  1. +44 −4 readme.md
View
@@ -16,6 +16,50 @@ For more information about the project, see [yeoman.io](http://yeoman.io).
* Navigate to a new directory and run `yeoman init` to make sure everything is working as expected.
+## Documentation
+
+Yeoman supports a powerful set of high-level commands. These include:
+
+```
+yeoman init # Initialize and scaffold a new project using generator templates
+yeoman build # Build an optimized version of your app, ready to deploy
+yeoman server # Launch a preview server which will begin watching for changes
+yeoman test # Run a Jasmine test harness in a headless Phantom.js
+
+yeoman install # Install a package from the clientside package registry
sindresorhus
sindresorhus Aug 1, 2012 Owner

client-side

+yeoman uninstall # Uninstall the package
+yeoman update # Update a package to the latest version
+yeoman list # List the packages currently installed
+yeoman search # Query the registry for matching package names
+yeoman lookup # Look up info on a particular package
+
+```
+
+A common initial workflow with Yeoman might be:
+
+```
+yeoman init # invoke the most basic application scaffold (Bootstrap, Boilerplate etc.)
+yeoman build # build your project, creating an optimized version in the publish folder
+yeoman server # create an intermediate version of your app, firing off a watch process.
sindresorhus
sindresorhus Aug 1, 2012 Owner

process [without dot]

+
sindresorhus
sindresorhus Aug 1, 2012 Owner

Invoke
Build
Create

+```
+
+Some more examples of how to use our commands include:
+
+```
+yeoman init angular:bootstrap # invoke the AngularJS generator scaffold
+yeoman init angular:controller # invoke the AngularJS Controller sub-generator
+yeoman install jquery underscore [depName] # install a dependency or dependencies
+yeoman update jquery # update a specific dependency (e.g jquery)
+yeoman search jquery # lookup jquery in the bower registry
sindresorhus
sindresorhus Aug 1, 2012 Owner

Align comments and a capitalize first character

Also: Bower

+
+```
+
+
+The current complete documentation for Yeoman can be found [here](http://yeoman.github.com/docs/docs.html). We also have extended documentation available [here](https://github.com/mklabs/yeoman/wiki/_pages).
sindresorhus
sindresorhus Aug 1, 2012 Owner

here links should generally be avoided

+
+
+
### Trouble-shooting
If for any reason you experience exceptions after the yeoman installation process above, you may find the
@@ -52,10 +96,6 @@ You then need to make it executable: `$ chmod +x server.sh`
For example, run this guy as `$ server` (defaults to port 8000), or supply a port yourself `$ server 3000`.
-## Documentation
-
-The current documentation for Yeoman can be found [here](http://yeoman.github.com/docs). If you are a new contributor and require access to this repository, feel free to ask.
-
## Browser Support

1 comment on commit f1f903c

@sindresorhus
Owner

Also would be nice with some syntax highlighting:

Please sign in to comment.