https://github.com/robdel12/github-display

Ember Addon that provides components to display github stuff
https://github.com/robdel12/github-display

Last synced: over 1 year ago
JSON representation

Ember Addon that provides components to display github stuff

• Host: GitHub
• URL: https://github.com/robdel12/github-display
• Owner: Robdel12
• License: apache-2.0
• Created: 2016-04-17T01:10:17.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-04-17T01:20:58.000Z (about 10 years ago)
• Last Synced: 2024-10-03T12:25:52.055Z (almost 2 years ago)
• Language: JavaScript
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Github-display

This addon provides some components to display github information

## Including it in your project

To package.json add:

```

  "devDependencies": {

    ...

    "github-display":"0.0.4"

    ...

  }

```

## Components

### repo-display

Shows information about a github repository.

TODO: needs to be fleshed out and made configuratbel

To use the component do:

```

{{repo-display id="langens-jonathan/github-display"}}

```


### repo-readme

Shows the readme for the repository with the given id

TODO: fleshing out, making it more flexible

To use the component do:

```

{{repo-readme repoId="langens-jonathan/github-display"}}

```


## Installation

* `git clone` this repository

* `npm install`

* `bower install`

## Running

* `ember server`

* Visit your app at http://localhost:4200.

## Running Tests

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

* `ember test`

* `ember test --server`

## Building

* `ember build`

For more information on using ember-cli, visit [http://www.ember-cli.com/](http://www.ember-cli.com/).