Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ateska authored Nov 3, 2023
1 parent c7aeedf commit 53858b0
Showing 1 changed file with 27 additions and 60 deletions.
87 changes: 27 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,31 @@ channel=general
- `token`: Your Slack OAuth access token.
- `channel`: The Slack channel you want to send messages to.

#### 🤖 Creating Xbot Tokens for Slack Apps

##### Prerequisites:
- A Slack workspace where you're the wizard of app creation.
- A GitHub repository for your spell formulas.

##### Steps:
1. Visit the [Slack API website](https://api.slack.com/apps).
2. "Create New App" - your wand for this journey.
3. Name your app and choose its home (workspace).
4. "Create App" and watch the magic happen!
5. Configure "OAuth & Permissions" - your spell's components.
6. Add the necessary scopes (e.g., `chat:write`, `files:write`).
7. "Install to Workspace" - like choosing where to cast your spell.
8. "Allow" - give your spell the go-ahead!
9. Copy the OAuth access token (your xbot token , a.k.a. magic key).

##### Adding the App to a Channel:
1. Choose a channel in your Slack workspace.
2. Invite the app (summon it to your channel).
3. Search for your app and select it.
4. Confirm the addition (consent is key in magic!).
5. Verify the app's presence (make sure the spell was cast correctly).


### 📬 3. Sending Microsoft Teams messages

**Overview:**
Expand Down Expand Up @@ -80,66 +105,8 @@ webhook_url=https://outlook.office.com/webhook/...

## 📚 More info

* [Documentation](https://teskalabs.github.io/asab-iris/).
* [Documentation](https://teskalabs.github.io/asab-iris/)

Architecture:
_Diagram: Architecture_

![Architecture](./docs/asab-iris-architecture.drawio.svg)


## 🎨 Template Storage and Usage

In the enchanting world of ASAB Iris, templates (especially those crafty Jinja ones) are the spells you cast to conjure up dynamic content for various communication channels like email and Slack.

**Storage Warning:**
Keep your templates in these sacred vaults or the mighty Templates node in Zookeeper, so they're ready for your next spell.

**Directory Structure:**
- `/Templates/Email/`: For your email incantations.
- `/Templates/Slack/`: For Slack spell-casting.
- `/Templates/MSTeams/`: For Microsoft Teams magic
- `/Templates/General/`: For your everyday sorcery.

**Explanation:**
- **Variables**: Your spell components (e.g., `{{ username }}`).
- **Control Statements**: Incantations for content control (like `if` and `for`).
- **Filters**: Magical modifiers for your variables.
- **Inheritance**: Keep your spellbook organized with a master grimoire and supplementary scrolls.

Remember, a tidy spellbook is a mighty spellbook! Store those templates wisely! 📜✨

## 🌐 Creating an Incoming Webhook for Outlook

1. Open your Outlook account and navigate to the "Settings" menu.
2. Search for "Webhooks" or "Connectors" in the Settings menu.
3. Click "Add" or "Create Webhook" to start the magic.
4. Name your webhook (e.g., "GitHub Webhook") so you can recognize it in your spellbook.
5. Set the webhook URL, ensuring it's a valid portal for your messages and files.
6. Choose the events or triggers that will summon the webhook.
7. Customize any additional incantations and save your new magical ally!

## 🤖 Creating Xbot Tokens for Slack Apps

### Prerequisites:
- A Slack workspace where you're the wizard of app creation.
- A GitHub repository for your spell formulas.

### Steps:
1. Visit the [Slack API website](https://api.slack.com/apps).
2. "Create New App" - your wand for this journey.
3. Name your app and choose its home (workspace).
4. "Create App" and watch the magic happen!
5. Configure "OAuth & Permissions" - your spell's components.
6. Add the necessary scopes (e.g., `chat:write`, `files:write`).
7. "Install to Workspace" - like choosing where to cast your spell.
8. "Allow" - give your spell the go-ahead!
9. Copy the OAuth access token (your xbot token , a.k.a. magic key).

### Adding the App to a Channel:
1. Choose a channel in your Slack workspace.
2. Invite the app (summon it to your channel).
3. Search for your app and select it.
4. Confirm the addition (consent is key in magic!).
5. Verify the app's presence (make sure the spell was cast correctly).

And voilà, you're all set to weave some ASAB Iris magic! ✨

0 comments on commit 53858b0

Please sign in to comment.