1 | # generator-octoblu-service
|
2 |
|
3 | [![Dependency status](http://img.shields.io/david/octoblu/generator-octoblu-service.svg?style=flat)](https://david-dm.org/octoblu/generator-octoblu-service)
|
4 | [![devDependency Status](http://img.shields.io/david/dev/octoblu/generator-octoblu-service.svg?style=flat)](https://david-dm.org/octoblu/generator-octoblu-service#info=devDependencies)
|
5 | [![Build Status](http://img.shields.io/travis/octoblu/generator-octoblu-service.svg?style=flat&branch=master)](https://travis-ci.org/octoblu/generator-octoblu-service)
|
6 |
|
7 | [![NPM](https://nodei.co/npm/generator-octoblu-service.svg?style=flat)](https://npmjs.org/package/generator-octoblu-service)
|
8 |
|
9 | A generator for [Yeoman](http://yeoman.io).
|
10 |
|
11 | ## Getting Started
|
12 |
|
13 | ### What is Yeoman?
|
14 |
|
15 | Trick question. It's not a thing. It's this guy:
|
16 |
|
17 | ![](http://i.imgur.com/JHaAlBJ.png)
|
18 |
|
19 | 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.
|
20 |
|
21 | 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.*
|
22 |
|
23 | ```
|
24 | $ npm install -g yo
|
25 | ```
|
26 |
|
27 | ### Yeoman Generators
|
28 |
|
29 | 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.
|
30 |
|
31 | To install generator-octoblu-service from npm, run:
|
32 |
|
33 | ```
|
34 | $ npm install -g generator-octoblu-service
|
35 | ```
|
36 |
|
37 | Create your project directory:
|
38 |
|
39 | ```
|
40 | $ mkdir my-project
|
41 | ```
|
42 |
|
43 | Navigate to your project directory:
|
44 |
|
45 | ```
|
46 | $ cd my-project
|
47 | ```
|
48 |
|
49 |
|
50 | Finally, initiate the generator:
|
51 |
|
52 | ```
|
53 | $ yo octoblu-service
|
54 | ```
|
55 |
|
56 | ### Getting To Know Yeoman
|
57 |
|
58 | 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.
|
59 |
|
60 | 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).
|
61 |
|
62 |
|
63 | ## License
|
64 |
|
65 | The MIT License (MIT)
|
66 |
|
67 | Copyright 2015 Jade Meskill
|
68 |
|
69 | Permission is hereby granted, free of charge, to any person obtaining a copy
|
70 | of this software and associated documentation files (the "Software"), to deal
|
71 | in the Software without restriction, including without limitation the rights
|
72 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
73 | copies of the Software, and to permit persons to whom the Software is
|
74 | furnished to do so, subject to the following conditions:
|
75 |
|
76 | The above copyright notice and this permission notice shall be included in
|
77 | all copies or substantial portions of the Software.
|
78 |
|
79 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
80 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
81 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
82 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
83 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
84 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
85 | THE SOFTWARE.
|