-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
@@ -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). | ||
|