generator-meshblu-connector
Version:
A generator for Yeoman
61 lines (33 loc) • 2.01 kB
Markdown
# generator-meshblu-connector [](https://travis-ci.org/iamruinous/generator-meshblu-connector)
> [Yeoman](http://yeoman.io) generator
## Getting Started
### What is Yeoman?
Trick question. It's not a thing. It's this guy:
Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.
Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*
```bash
npm install -g yo
```
### Yeoman Generators
Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.
To install generator-meshblu-connector from npm, run:
```bash
npm install -g generator-meshblu-connector
```
Finally, initiate the generator:
```bash
yo meshblu-connector
```
### Upgrading
This generator works well with existing connectors but there is script that makes it easier to understand and upgrade a legacy connector.
The script is located at the root of this project and is called `./update-connector`
#### Usage
```bash
update-meshblu-connector <connector-name> [/path/to/project/folder]
```
### Getting To Know Yeoman
Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.
If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).
## License
MIT