Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
san650 committed Aug 2, 2016
1 parent 758d873 commit aa5a717
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 20 deletions.
22 changes: 16 additions & 6 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
The MIT License (MIT)
Copyright (c) 2016 Santiago Ferreira

Copyright (c) 2016
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
87 changes: 73 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,85 @@
# ember-addons-inspector
![Latest version](https://img.shields.io/npm/v/ember-addons-inspector.svg)

This README outlines the details of collaborating on this Ember addon.
Get all the information about the addons registered in your Ember project (addon
or application). This addon adds an `inspect` command which facilitates
inspecting your project and learn all about the addons registered in it.

## Sinopsis

List all the addons in the project

```
$ ember inspect
Inspecting app...
Found 36 addon(s), 0 disabled.
* ember-buffered-proxy (0.5.1)
An Ember Object Proxy with change buffering
* ember-cli-app-version (1.0.0)
Add App version number to Ember Inspector Info Tab
* ember-cli-babel (5.1.6)
This Ember-CLI plugin uses [Babel](https://babeljs.io/) to allow you to use ES6 syntax with your Ember-CLI project.
* ember-cli-dependency-checker (1.2.0)
Ember CLI addon for detecting missing npm and bower dependencies before executing ember commands
...
```

and then you can inspect an individual addon

```
$ ember inspect ember-buffered-proxy
Inspecting app...
Found 36 addon(s), 0 disabled.
Inspecting ember-buffered-proxy
description: An Ember Object Proxy with change buffering
version: 0.5.1
homepage: https://github.com/yapplabs/ember-buffered-proxy#readme
bugs: [object Object]
repository: [object Object]
author: [object Object]
license: MIT
```

This is work in progress and the idea is to add tons of information about the
addons.

## Installation

* `git clone` this repository
* `npm install`
* `bower install`
```
$ ember install ember-addons-inspector
```

## Development

### Source code

```
$ git clone https://github.com/san650/ember-addons-inspector.git
```

## Running
### Running Tests

* `ember server`
* Visit your app at http://localhost:4200.
```
$ npm test
```

## Running Tests
### Project's health

* `npm test` (Runs `ember try:testall` to test your addon against multiple Ember versions)
* `ember test`
* `ember test --server`
TBA

## Building
## License

* `ember build`
ember-addons-inspector is licensed under the MIT license.

For more information on using ember-cli, visit [http://ember-cli.com/](http://ember-cli.com/).
See [LICENSE](./LICENSE.md) for the full license text.

0 comments on commit aa5a717

Please sign in to comment.