Skip to content

Commit 04756b9

Browse files
committed
Link to documentation
1 parent 5edb598 commit 04756b9

1 file changed

Lines changed: 6 additions & 17 deletions

File tree

README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,9 @@
88

99
An easily-deployable microservice for collecting user feedback as GitHub issues.
1010

11-
## Usage
12-
13-
Send a POST request to `https://microfeedback-github.now.sh/<github-user>/<github-repo>`
14-
with a JSON body containing a "body" key and a string value containing
15-
content.
16-
17-
Example:
18-
19-
```
20-
curl -d '{"body": "this is great!"}' \
21-
-H 'Content-Type: application/json' \
22-
https://microfeedback-github.now.sh/microfeedback/testrepo
23-
```
24-
25-
The feedback will be posted on the given GitHub repo's issue tracker.
11+
## Documentation
2612

13+
https://microfeedback.js.org/backends/microfeedback-github/
2714

2815
## API
2916

@@ -46,13 +33,15 @@ microfeedback-github to now using the `now` CLI.
4633

4734
### One command deploy
4835

49-
Use the `now` CLI to deploy this repo. You will be prompted to enter the GitHub API token associated
50-
with your feedback bot's GitHub account.
36+
Use the `now` CLI to deploy this repo.
5137

5238
```
5339
now microfeedback/microfeedback-github
5440
```
5541

42+
You will be prompted to enter the GitHub API token associated
43+
with your feedback bot's GitHub account.
44+
5645
For more detailed setup instructions, see the next section.
5746

5847
## Detailed instructions

0 commit comments

Comments
 (0)