Skip to content

Commit

Permalink
readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Sep 7, 2015
1 parent 97b1ad6 commit 4ff2bf2
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,45 @@
# Yo [![Build Status](https://travis-ci.org/yeoman/yo.svg?branch=master)](https://travis-ci.org/yeoman/yo) [![](http://img.shields.io/badge/unicorn-approved-ff69b4.svg)](https://www.youtube.com/watch?v=9auOCbH5Ns4)
# yo [![Build Status](https://travis-ci.org/yeoman/yo.svg?branch=master)](https://travis-ci.org/yeoman/yo) [![](http://img.shields.io/badge/unicorn-approved-ff69b4.svg)](https://www.youtube.com/watch?v=9auOCbH5Ns4)

![](https://raw.githubusercontent.com/yeoman/media/master/optimized/yeoman-masthead.png)
[![](https://raw.githubusercontent.com/yeoman/media/master/optimized/yeoman-masthead.png)](http://yeoman.io)

<img src="screenshot.png" width="569">


## What's Yeoman?

Yeoman helps you to kickstart new projects, prescribing best practices and tools to help you stay productive.

To do so, we provide a [generator ecosystem](http://yeoman.io/generators/). A generator is basically a plugin that can be run with the `yo` command to scaffold complete projects or useful parts.


## Usage

```bash
# First install a generator
npm -g install generator-webapp
```sh
# install yo
npm install --global yo

# install a generator
npm install --global generator-webapp

# Then run it
# run it
yo webapp
```

To find a generator, visit http://yeoman.io/generators/
*To create and distribute your own generator, refer to [our official documentation](http://yeoman.io/authoring/)*

To create and distribute your own generator, refer to [our official documentation](http://yeoman.io/authoring/)

## Options

- `--no-color` Disable colors.
- `--version` Print the current `yo` version.
- `--help` Print `yo` help menu with the list of found generators.
- `--[no-]insight` to toggle anonymous [Insight](https://github.com/yeoman/insight) tracking which helps us improve Yeoman. Using either of these flags on the first run will prevent you from being prompted about it interactively. The flags can also be used to change it later on.
- `--generators` Print available generators.
- `--no-color` - Disable colors.
- `--version` - Print the current `yo` version.
- `--help` - Print `yo` help menu with the list of found generators.
- `--[no-]insight` - Toggle anonymous [Insight](https://github.com/yeoman/insight) tracking which helps us improve Yeoman. Using either of these flags on the first run will prevent you from being prompted about it interactively. The flags can also be used to change it later on.
- `--generators` - Print available generators.


## Troubleshooting

Running `yo doctor` command can help you troubleshoot most common issues.
Running `yo doctor` command can help you troubleshoot common issues.

If `doctor` doesn't help, then check opened issues for a similar problem. Open a new issue if your problem haven't been reported yet. Make sure to always include the version of `yo` (`yo --version`) and Node.js (`node --version`) you use.

Expand Down

0 comments on commit 4ff2bf2

Please sign in to comment.