Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jpatel531 committed Aug 24, 2015
1 parent 559aaa7 commit f66cb12
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ Currently, you are given default Pusher credentials when you install the package
Here is a current list of features:

* Text synchronization
* Multiple tab syncing
* File-sharing
* HipChat invitations
* Slack invitations
Expand All @@ -83,6 +84,31 @@ Here is a current list of features:

But if there are any features you find lacking, feel more than welcome to [get in touch](<mailto:[email protected]>).

### Running Tests

To run the tests, just type into your command line at the root of the project:

$ apm test

### Adding New Methods of Invitation

Currently there is support for inviting people over HipChat and Slack. If you would like to invite friends or colleagues through any other integration, there is a mini-API to make this more simple. All you have to do is inherit from our `Invitation` class and implement two methods:

```coffee
class YourInvitation extends Invitation

checkConfig: ->
# Must be implemented
# Returns false if they are missing your integration's API keys, otherwise true.

send: (callback)->
# Must be implemented
# Send your invitation and simple call the callback when you're done.

```

See [here](https://github.com/pusher/atom-pair/blob/master/lib/modules/invitations/slack_invitation.coffee) for an example.

## Credits

This project is owned and maintained by [@jpatel531](http://github.com/jpatel531), a developer at [Pusher](http://pusher.com).
Expand Down

0 comments on commit f66cb12

Please sign in to comment.