From c9c32625d738bc235f1b4b368388fffe01895f54 Mon Sep 17 00:00:00 2001 From: Bernhard B Date: Thu, 30 May 2019 19:53:38 +0200 Subject: [PATCH 1/4] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 91f096d..6193402 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dockerized signal-cli REST API -This project creates a small dockerized REST API around signal-cli(https://github.com/AsamK/signal-cli). +This project creates a small dockerized REST API around [signal-cli](https://github.com/AsamK/signal-cli). At the moment, the following functionality is exposed via REST: @@ -30,7 +30,8 @@ services: Sample REST API calls: * Register a number (with SMS verification) -```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/register/'``` + + ```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/register/'``` e.g: ```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register/+431212131491291'``` From a09444cd5081ee39aafbdf5a26c09f0dd8d78ad5 Mon Sep 17 00:00:00 2001 From: Bernhard B Date: Thu, 30 May 2019 19:55:10 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6193402..73995d9 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ At the moment, the following functionality is exposed via REST: * Register a number * Verify the number using the code received via SMS -* Send message to multiple recipients +* Send message (+ attachment) to multiple recipients ## Examples @@ -33,25 +33,28 @@ Sample REST API calls: ```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/register/'``` -e.g: -```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register/+431212131491291'``` + e.g: + + ```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register/+431212131491291'``` * Verify the number using the code received via SMS -```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register//verify/'``` -e.g: -```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register/+431212131491291/verify/123-456'``` + ```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register//verify/'``` + + e.g: + + ```curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register/+431212131491291/verify/123-456'``` * Send message to multiple recipients -```curl -X POST -H "Content-Type: application/json" -d '{"message": "", "number": "", "recipients": ["", ""]}' 'http://127.0.0.1:8080/v1/send'``` + ```curl -X POST -H "Content-Type: application/json" -d '{"message": "", "number": "", "recipients": ["", ""]}' 'http://127.0.0.1:8080/v1/send'``` -e.g: + e.g: -```curl -X POST -H "Content-Type: application/json" -d '{"message": "Hello World!", "number": "+431212131491291", "recipients": ["+4354546464654", "+4912812812121"]}' 'http://127.0.0.1:8080/v1/send'``` + ```curl -X POST -H "Content-Type: application/json" -d '{"message": "Hello World!", "number": "+431212131491291", "recipients": ["+4354546464654", "+4912812812121"]}' 'http://127.0.0.1:8080/v1/send'``` * Send a message (+ base64 encoded attachment) to multiple recipients -```curl -X POST -H "Content-Type: application/json" -d '{"message": "", "base64_attachment": "", "number": "", "recipients": ["", ""]}' 'http://127.0.0.1:8080/v1/send'``` + ```curl -X POST -H "Content-Type: application/json" -d '{"message": "", "base64_attachment": "", "number": "", "recipients": ["", ""]}' 'http://127.0.0.1:8080/v1/send'``` In case you need more functionality, please create a pull request! From 6a9df85ed55393bf2764e2e075e76438eb8c4ac5 Mon Sep 17 00:00:00 2001 From: Bernhard B Date: Thu, 30 May 2019 19:55:43 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 73995d9..1f452b2 100644 --- a/README.md +++ b/README.md @@ -57,4 +57,4 @@ Sample REST API calls: ```curl -X POST -H "Content-Type: application/json" -d '{"message": "", "base64_attachment": "", "number": "", "recipients": ["", ""]}' 'http://127.0.0.1:8080/v1/send'``` -In case you need more functionality, please create a pull request! +In case you need more functionality, please **create a pull request** From 3ae2ba0cb0e2bb7c6ddaaf4d99c45db15edd71fd Mon Sep 17 00:00:00 2001 From: Bernhard B Date: Thu, 30 May 2019 21:51:12 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f452b2..ac02765 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Sample `docker-compose.yml`file: version: "3" services: signal-cli-rest-api: - build: "." + image: bbernhard/signal-cli-rest-api:latest ports: - "8080:8080" #map docker port 8080 to host port 8080. network_mode: "host"