1
0
mirror of synced 2024-11-22 21:06:06 +03:00
messenger/README.md

40 lines
2.8 KiB
Markdown
Raw Normal View History

2018-03-15 22:37:45 +03:00
# Messenger [![GoDoc](https://godoc.org/github.com/paked/messenger?status.svg)](https://godoc.org/github.com/paked/messenger) [![Build Status](https://travis-ci.org/paked/messenger.svg?branch=master)](https://travis-ci.org/paked/messenger)
2016-04-13 10:09:28 +03:00
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.
2016-04-13 10:09:28 +03:00
2018-03-15 23:43:51 +03:00
You can find [examples for this library here](https://github.com/paked/messenger/blob/master/examples/).
2016-04-15 03:41:03 +03:00
2019-01-04 12:45:37 +03:00
We tag our releases Semver style.
2016-04-14 13:10:40 +03:00
## Tips
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!
2016-04-14 13:10:40 +03:00
- You need a Facebook development app, and a Facebook page in order to build things.
2016-11-27 12:22:11 +03:00
- Use [ngrok](https://ngrok.com) to tunnel your locally running bot so that Facebook can reach the webhook.
2016-04-14 13:10:40 +03:00
2016-05-20 02:25:21 +03:00
## Breaking Changes
2019-01-04 12:45:37 +03:00
In January 2019 we began tagging releases so that the package could be used properly with Go modules. Prior to that we simply maintained the following list to help users migrate between versions, it's staying here for legacy reasons. From now on, however, you should find breaking changes in the notes of a new release.
2016-05-20 02:25:21 +03:00
2019-01-04 12:45:37 +03:00
`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.
2016-05-20 02:25:21 +03:00
- 06/2/18: Added messaging_type field for message send API request as it is required by FB
- [23/1/17](https://github.com/paked/messenger/commit/1145fe35249f8ce14d3c0a52544e4a4babdc15a4): Updating timezone type to `float64` in profile struct
- [12/9/16](https://github.com/paked/messenger/commit/47f193fc858e2d710c061e88b12dbd804a399e57): Removing unused parameter `text string` from function `(r *Response) GenericTemplate`.
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.
2018-03-15 22:37:45 +03:00
- [4/5/16](https://github.com/paked/messenger/commit/eb0e72a5dcd3bfaffcfe88dced6d6ac5247f9da1): The URL to use for the webhook is changable in the `Options` struct.
2016-05-20 02:25:21 +03:00
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)
2016-09-28 12:23:56 +03:00
2016-09-28 12:28:12 +03:00
## Projects
2016-09-28 12:23:56 +03:00
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.
2016-09-28 12:23:56 +03:00
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.
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