Skip to content
This repository was archived by the owner on Dec 2, 2023. It is now read-only.

Commit 518bc40

Browse files
committed
docs: update README [ci skip]
1 parent 71df2de commit 518bc40

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,40 @@
11
# Docbase Url Expander
22

3+
Slack bot for unfurling [Docbase](https://docbase.io) URLs.
4+
5+
[![Latest Version](https://img.shields.io/github/v/release/kei711/docbase-url-expander)](https://github.com/kei711/docbase-url-expander/releases)
36
[![Build](https://github.com/kei711/docbase-url-expander/actions/workflows/main.yml/badge.svg)](https://github.com/kei711/docbase-url-expander/actions/workflows/main.yml)
47

58
[GitHub Container Registry](https://github.com/kei711/docbase-url-expander/pkgs/container/docbase-url-expander)
69

7-
## Prerequisite
10+
## Usage
11+
12+
```shell
13+
# copy and edit the .env file
14+
cp .env.sample .env
15+
docker run --env-file .env --init --rm ghcr.io/kei711/docbase-url-expander:latest
16+
```
17+
18+
### Environment variables
19+
20+
- SLACK_BOT_TOKEN
21+
- Bot token strings begin with `xoxb-`
22+
- SLACK_APP_TOKEN
23+
- App token strings begin with `xapp-`
24+
- DOCBASE_TEAM_NAME
25+
- `https://<DOCBASE_TEAM_NAME>.docbase.io`
26+
- DOCBASE_ACCESS_TOKEN
27+
- Access token of Docbase
28+
- see [アクセストークン作成方法](https://help.docbase.io/posts/45703#%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9%E3%83%88%E3%83%BC%E3%82%AF%E3%83%B3%E4%BD%9C%E6%88%90%E6%96%B9%E6%B3%95)
29+
30+
## For local development
31+
32+
### Prerequisite
833

934
- Node.js 16.x
1035
- Yarn 1.x
1136
- direnv
1237

13-
## Commands
14-
1538
### Setup
1639

1740
```shell

0 commit comments

Comments
 (0)