YOURLS Extension Generator

Yeoman generator for creating YOURLS extensions

This script help to create YOURLS 2.0+ extensions in a second.

Getting Started

What is this generator?

This generator helps you to bootstrap the creation of a YOURLS extension such as:

• Plugin — How to
• Theme — Explanations
• Translation — Documentation

What is Yeoman?

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 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.

$ npm install -g yo

Install the Generator

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 YOURLS extension.

To install generator-yourls-extension from npm, run:

$ npm install -g generator-yourls-extension

Finally, initiate the generator and follow instructions:

$ yo yourls-extension

License

Licensed under MIT License