messenger/README.md

# Messenger [![GoDoc](https://godoc.org/github.com/paked/messenger?status.svg)](https://godoc.org/github.com/paked/messenger)

This is a Go library for making bots to be used on Facebook messenger. It is built on the [Messenger Platform](https://developers.facebook.com/docs/messenger-platform). One of the main goals of the project is to implement it in an idiomatic and easy to use fashion.

[You can find an example of how to use it here](https://github.com/paked/messenger/blob/master/cmd/bot/main.go)

## Tips

- Follow the [quickstart](https://developers.facebook.com/docs/messenger-platform/quickstart) guide for getting everything set up!
- You need a Facebook development app, and a Facebook page in order to build things.
- Use [ngrok](https://ngrok.com) to tunnel your locally runnning bot so that Facebook can reach the webhook.

## Breaking Changes

`paked/messenger` is a pretty stable library however, changes will be made which might break backwards compatibility. For the convenience of its users, these are documented here.


- [12/9/16](https://github.com/paked/messenger/commit/47f193fc858e2d710c061e88b12dbd804a399e57): Removing unused parameter `text string` from function `(r *Response) GenericTemplate`.
- [20/5/16](https://github.com/paked/messenger/commit/1dc4bcc67dec50e2f58436ffbc7d61ca9da5b943): Leaving the `WebhookURL` field blank in `Options` will yield a URL of "/" instead of a panic.
- [4/5/16](https://github.com/paked/messenger/commit/eb0e72a5dcd3bfaffcfe88dced6d6ac5247f9da1): The URL to use for the webhook is changable in the `Options` struct. 

## Inspiration

Messenger takes design cues from:

- [`net/http`](https://godoc.org/net/http)
- [`github.com/nickvanw/ircx`](https://github.com/nickvanw/ircx)

## Projects

This is a list of projects use `messenger`. If you would like to add your own, submit a [Pull Request](https://github.com/paked/messenger/pulls/new) adding it below.

- [meme-maker](https://github.com/paked/meme-maker) by @paked: A bot which, given a photo and a caption, will create a macro meme.
- [drone-facebook](https://github.com/appleboy/drone-facebook) by @appleboy: [Drone.io](https://drone.io) plugin which sends Facebook notifications
Update README 2016-04-15 03:26:04 +03:00			`# Messenger [![GoDoc](https://godoc.org/github.com/paked/messenger?status.svg)](https://godoc.org/github.com/paked/messenger)`
Add a proper README 2016-04-13 10:09:28 +03:00
Fix typo in README 2016-04-13 12:51:28 +03:00			`This is a Go library for making bots to be used on Facebook messenger. It is built on the [Messenger Platform](https://developers.facebook.com/docs/messenger-platform). One of the main goals of the project is to implement it in an idiomatic and easy to use fashion.`
Add a proper README 2016-04-13 10:09:28 +03:00
Add link to example 2016-04-15 03:41:03 +03:00			`[You can find an example of how to use it here](https://github.com/paked/messenger/blob/master/cmd/bot/main.go)`

Add tips 2016-04-14 13:10:40 +03:00			`## Tips`

Fix broken link 2016-04-15 03:33:50 +03:00			`- Follow the [quickstart](https://developers.facebook.com/docs/messenger-platform/quickstart) guide for getting everything set up!`
Add tips 2016-04-14 13:10:40 +03:00			`- You need a Facebook development app, and a Facebook page in order to build things.`
			`- Use [ngrok](https://ngrok.com) to tunnel your locally runnning bot so that Facebook can reach the webhook.`

Add breaking changes note 2016-05-20 02:25:21 +03:00			`## Breaking Changes`

			`paked/messenger` is a pretty stable library however, changes will be made which might break backwards compatibility. For the convenience of its users, these are documented here.


Added the new breaking change in README 2016-09-11 22:47:01 +03:00			- [12/9/16](https://github.com/paked/messenger/commit/47f193fc858e2d710c061e88b12dbd804a399e57): Removing unused parameter `text string` from function `(r *Response) GenericTemplate`.
Fix formatting 2016-05-20 02:30:33 +03:00			- [20/5/16](https://github.com/paked/messenger/commit/1dc4bcc67dec50e2f58436ffbc7d61ca9da5b943): Leaving the `WebhookURL` field blank in `Options` will yield a URL of "/" instead of a panic.
			- [4/5/16](https://github.com/paked/messenger/commit/eb0e72a5dcd3bfaffcfe88dced6d6ac5247f9da1): The URL to use for the webhook is changable in the `Options` struct.
Add breaking changes note 2016-05-20 02:25:21 +03:00
Add a proper README 2016-04-13 10:09:28 +03:00			`## Inspiration`

			`Messenger takes design cues from:`

			- [`net/http`](https://godoc.org/net/http)
			- [`github.com/nickvanw/ircx`](https://github.com/nickvanw/ircx)
Add example project list (#11) 2016-09-28 12:23:56 +03:00
Fix projects list 2016-09-28 12:28:12 +03:00			`## Projects`
Add example project list (#11) 2016-09-28 12:23:56 +03:00
Fix projects list 2016-09-28 12:28:12 +03:00			This is a list of projects use `messenger`. If you would like to add your own, submit a [Pull Request](https://github.com/paked/messenger/pulls/new) adding it below.
Add example project list (#11) 2016-09-28 12:23:56 +03:00
Fix project URL (#17) 2016-11-05 03:04:39 +03:00			`- [meme-maker](https://github.com/paked/meme-maker) by @paked: A bot which, given a photo and a caption, will create a macro meme.`
Fix projects list 2016-09-28 12:28:12 +03:00			`- [drone-facebook](https://github.com/appleboy/drone-facebook) by @appleboy: [Drone.io](https://drone.io) plugin which sends Facebook notifications`