Skip to content

Commit 832e316

Browse files
committed
updated README.md
1 parent 27fb739 commit 832e316

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This connector allows you to get a stream of issues and pull requests from your GitHub repository, using the GitHub Api: https://developer.github.com/v3/issues/#list-issues-for-a-repository
44

5-
Issues are pulled based on "updated_at" field, meaning any update to an issue or pull request will appear in the stream.
5+
Issues are pulled based on `updated_at` field, meaning any update to an issue or pull request will appear in the stream.
66

77
The connector writes to topic that is great candidate to demonstrate *log compaction*. It's also a fun way to automate your GitHub workflow.
88

@@ -13,6 +13,7 @@ It's finally aimed to be an educative example to demonstrate how to write a Sour
1313
This connector is not perfect and can be improved, please feel free to submit any PR you deem useful.
1414

1515
# Configuration
16+
1617
```
1718
name=GitHubSourceConnectorDemo
1819
tasks.max=1
@@ -28,6 +29,8 @@ auth.password=your_password
2829

2930
# Running in development
3031

32+
Note: Java 8 is required for this connector.
33+
3134
```
3235
./build.sh
3336
./run.sh
@@ -37,4 +40,6 @@ I plan on creating a Dockerfile to simplify running this connector in standalone
3740

3841
# Deploying
3942

43+
Note: Java 8 is required for this connector.
44+
4045
TODO

0 commit comments

Comments
 (0)