Skip to content

Commit de8eda5

Browse files
authored
updated README
made Setup more clear
1 parent 8bbcf9a commit de8eda5

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

.github/templates/README.template.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,19 @@ Take a look at traefik implementation:
2424

2525
Before you can send messages via `secured-signal-api` you must first setup [`signal-api`](https://github.com/bbernhard/signal-cli-rest-api/blob/master/doc/EXAMPLES.md),
2626

27-
to send messages you have to either:
27+
to be able to use the API you have to either:
2828

2929
- **register a Signal Account**
3030

3131
OR
3232

3333
- **link Signal API to an already registered Signal Device**
3434

35+
> [!Hint]
36+
> It is advised to do this by directly accessing `signal-api`
37+
> As Secured Signal API blocks the `/register` and `/qrcodelink` by default.
38+
> If you really want to you can do this with Secured Signal API by removing these endpoints from the Blocklist
39+
3540
## Usage
3641

3742
Secured Signal API implements 3 Ways to Authenticate

0 commit comments

Comments
 (0)