forked from aurelia/registry
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(registry): Added registry for plugins
This includes the optional CLI plugins as well.
- Loading branch information
Showing
2 changed files
with
64 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,32 @@ | ||
# registry | ||
# aurelia-registry | ||
|
||
[](https://zenhub.io) | ||
[](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 */ | ||
} | ||
] | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
} | ||
] | ||
} |