Skip to content

Commit

Permalink
feat(registry): Added registry for plugins
Browse files Browse the repository at this point in the history
This includes the optional CLI plugins as well.
  • Loading branch information
plwalters committed May 28, 2015
1 parent a138351 commit acbe4d1
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
# registry
# aurelia-registry

[![ZenHub](https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png)](https://zenhub.io)
[![Join the chat at https://gitter.im/aurelia/discuss](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/aurelia/discuss?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

A registry of Aurelia plugins, cli plugins, gists and other awesome goodies you can use with Aurelia and its tools.

> To keep up to date on [Aurelia](http://www.aurelia.io/), please visit and subscribe to [the official blog](http://blog.durandal.io/). If you have questions, we invite you to [join us on Gitter](https://gitter.im/aurelia/discuss). If you would like to have deeper insight into our development process, please install the [ZenHub](https://zenhub.io) Chrome Extension and visit any of our repository's boards. You can get an overview of all Aurelia work by visiting [the framework board](https://github.com/aurelia/framework#boards).
## How does it work?

The registry is a list of plugins that can be used with Aurelia. They will be located and downloaded with JSPM on the registry / location that is specified.

## Adding to the registry

* Add your plugin in **alphabetical order** based on the name property
* Fork this registry and create a PR

To add your plugin to the registry, please make to follow the following JSON format -

```language-javascript
{
"plugins": [
{
"name": "NAME-OF-YOUR-PLUGIN",
"endpoint": "github", /* github, npm, etc... */
"location": "aurelia/validation", /* where is it on that endpoint? */
"cli": [ 'cli-plugin-command1', 'cli-plugin-command2' ], /* names of commands to register for cli */
}
]
}
```
34 changes: 34 additions & 0 deletions plugin-registry.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"plugins": [
{
"name": "animator-css",
"endpoint": "github",
"location": "aurelia/animator-css"
},
{
"name": "breeze",
"endpoint": "github",
"location": "jdanyow/aurelia-breeze"
},
{
"name": "i18next",
"endpoint": "github",
"location": "zewa666/aurelia-i18next"
},
{
"name": "leaflet",
"endpoint": "github",
"location": "ceoaliongroo/aurelia-leaflet"
},
{
"name": "modal",
"endpoint": "github",
"location": "pwkad/aurelia-bs-modal"
},
{
"name": "validation",
"endpoint": "github",
"location": "aurelia/validation"
}
]
}

0 comments on commit acbe4d1

Please sign in to comment.