Skip to content

Commit

Permalink
improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ruKurz committed Jun 25, 2019
1 parent 65747c3 commit 09e5380
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Assistify - GitLab integration

Integrates GitLab with Assistify.
_**Integrates GitLab with Assistify.**_

This app connects GitLab with Assistify. Users are notified directly in the Assistify chat about code changes and the current build status. In addition, this app allows users to reference, browse and create issues in the chat.

Expand Down Expand Up @@ -51,11 +51,14 @@ Now you need a channel where the GitLab notifications should appear. This must h
**Note:** Ideally, you should use the same usernames in GitLab and Assistify. Then the user who triggered the event in GitLab will be used as the sender of the notifications in Assistify. The integration works even if the channel does not have the same name. However, the name of the sender of the notifications is always "Assistify.Admin".


## Documentation
## References

https://github.com/RocketChat/Rocket.Chat.Apps-cli
https://docs.gitlab.com/ee/user/project/integrations/webhooks.html
### Releated documentation

- [Rocket.Chat Apps CLI documentation](https://github.com/RocketChat/Rocket.Chat.Apps-cli)
- [GitLab WebHook documentation](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html)

### Developing Rocket.Chat apps
Here are some links to examples and documentation:
- [Rocket.Chat Apps TypeScript Definitions Documentation](https://rocketchat.github.io/Rocket.Chat.Apps-engine/)
- [Rocket.Chat Apps TypeScript Definitions Repository](https://github.com/RocketChat/Rocket.Chat.Apps-engine)
Expand Down

0 comments on commit 09e5380

Please sign in to comment.