Skip to content

Commit

Permalink
Update README (#197)
Browse files Browse the repository at this point in the history
  • Loading branch information
d-gubert committed Dec 10, 2019
1 parent e835628 commit 65eaacd
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
# Rocket.Chat Apps Engine
The engine which manages and controls everything....more details coming soon.

## Thoughts While Working (for docs)
- Apps which don't provide a valid uuid4 id will be assigned one, but this is not recommended and your App should provide an id
- The language strings are only done on the clients (`TAPi18next.addResourceBundle(lang, projectName, translations);`)
- The implementer of this should restrict the server setting access and environmental variables. Idea is to allow the implementer to have a default set of restricted ones while letting the admin/owner of the server to restrict it even further or lift the restriction on some more. Simple interface with settings and checkbox to allow/disallow them. :thinking:

## To Think About?
- Will we support es6? Since we currently check `extends` keyword and can check `implements` via determing what methods exist
- Using https://www.npmjs.com/package/jsonc-parser for the json parsing?
## What does the Apps-Engine enable you to do?
The Apps-Engine is Rocket.Chat's _plugin framework_ - it provides the APIs for Rocket.Chat Apps to interact with the host system.

Currently, a Rocket.Chat App can:
- Listen to message events (before a message is sent, after a message is updated, etc)
- Listen to room events (before a room is created, after a room is deleted)
- Send messages to users and livechat visitors
- Register new slash commands
- Register new HTTP endpoints

Some features the Engine allows Apps to use:
- Key-Value Storage system
- App specific settings

## Development environment with Rocket.Chat
When developing new functionalities, you need to integrate the local version of the Apps-Engine with your local version of Rocket.Chat.
Expand Down

0 comments on commit 65eaacd

Please sign in to comment.