diff --git a/documentation/README.md b/documentation/README.md new file mode 100644 index 0000000..2eabc24 --- /dev/null +++ b/documentation/README.md @@ -0,0 +1,7 @@ +
You can create a github pages website by creating a new repo with the name github-username.github.io. For help and more information, please read through the guide
Create a json file in the sub-logs directory (sub-logs/subdomain.is-a-good.dev).
Please make sure that your json file follows the following format:
+
+ {
+ "repo": "https://github.com/github-username/github-username.github.io",
+ "owner": {
+ "username": "github-username",
+ "email": "your-name-here@domain",
+ },
+ "target": {
+ "CNAME": "github-username.github.io"
+ }
+ }
+