Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/davidfurlong/feedbackBot

Feedback button that posts a screenshot, description and browser info to your github issues
https://github.com/davidfurlong/feedbackBot

Last synced: 5 days ago
JSON representation

Feedback button that posts a screenshot, description and browser info to your github issues

Awesome Lists containing this project

README

        

feedbackBot
========

The simplest feedback tool out there.
Include feedbackBot and receive screenshots, description and browser info straight in your github issues.

Built as a clone to Google's Feedback process

## Usage

bower install feedback-bot

OR

Load jQuery, the plugin, and its CSS:
```html




```

AND THEN

Init plugin:
```html

$.feedback({
html2canvasURL: 'src/html2canvas.js',
githubpath: 'ToolsforSociety/feedbackBot', // CHANGE THIS TO YOUR PATH
serverURL: 'http://feedbackbot.herokuapp.com' // YOU CAN HOST YOUR OWN GITHUB BOT IF YOU WANT
});

```

Add the button
```html
Feedback
```

## Requirements

* jQuery
* html2canvas

## Compatibility

Pretty much it should be working on any browser with `canvas` support. Browsers with no canvas support won't display the feedback button.

## License

feedbackBot is released under the MIT license. (See `LICENSE`)