An open API service indexing awesome lists of open source software.

https://github.com/levlaz/releases

Uses GitHub API to show feed of releases for a given project
https://github.com/levlaz/releases

Last synced: 6 months ago
JSON representation

Uses GitHub API to show feed of releases for a given project

Awesome Lists containing this project

README

          

# releases
Uses GitHub API to show feed of releases and open bugs for a given project. You can see a live version of releases in action [here](https://braindump.pw).

## Preview

![Preview Image](https://levlaz.org/wp-content/uploads/2015/11/Screenshot-2015-11-24-19.47.48.png)

## Installation

Releases is now packaged as a npm module, you can install it with `npm install releases`.

## Usage

Add the following HTML to the page where you want the releases to be displayed.

```


Known Issues




Latest Releases







```

Load the following scripts on the same page as where you put the code above. (*note* if you are using Bootstrap you probably are already loading jQuery)

```

```

Add the Styles from style.css to your existing stylesheet.

```
/* Style for Releases Plugin */
#releases {
list-style-type: none;
margin: 0;
padding: 0;
}
```

Update the `window.repo` variable on [Line 5](https://github.com/levlaz/releases/blob/master/js/releases.js#L5) of `releases.js` to be whatever repo you want to display releases for.