{"action":"created","comment":{"url":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/comments/222587022","pull_request_review_id":161507194,"id":222587022,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIyMjU4NzAyMg==","diff_hunk":"@@ -1,38 +1,63 @@\n+<p align=\"center\">\n+    <a href=\"http://kitura.io/\">\n+        <img src=\"https://raw.githubusercontent.com/IBM-Swift/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true\" height=\"100\" alt=\"Kitura\">\n+    </a>\n+</p>\n+\n+<p align=\"center\">\n+    <a href=\"https://ibm-swift.github.io/FileKit/index.html\">\n+    <img src=\"https://img.shields.io/badge/apidoc-FileKit-1FBCE4.svg?style=flat\" alt=\"APIDoc\">\n+    </a>\n+    <a href=\"https://travis-ci.org/IBM-Swift/FileKit\">\n+    <img src=\"https://travis-ci.org/IBM-Swift/FileKit.svg?branch=master\" alt=\"Build Status - Master\">\n+    </a>\n+    <img src=\"https://img.shields.io/badge/os-macOS-green.svg?style=flat\" alt=\"macOS\">\n+    <img src=\"https://img.shields.io/badge/os-linux-green.svg?style=flat\" alt=\"Linux\">\n+    <img src=\"https://img.shields.io/badge/license-Apache2-blue.svg?style=flat\" alt=\"Apache 2\">\n+    <a href=\"http://swift-at-ibm-slack.mybluemix.net/\">\n+    <img src=\"http://swift-at-ibm-slack.mybluemix.net/badge.svg\" alt=\"Slack Status\">\n+    </a>\n+</p>\n+\n # FileKit\n \n-> Utility for resolving common paths\n+Resolves commonly used paths, including the project, executable and working directories.\n+\n+## Version\n+The latest release of `FileKit` (0.x.x) runs on Swift 4.0 and newer, on both macOS and Ubuntu Linux.\n+\n+## Usage\n \n-[![Build Status - Master](https://travis-ci.org/IBM-Swift/FileKit.svg?branch=master)](https://travis-ci.org/IBM-Swift/FileKit)\n-![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat)\n-![Linux](https://img.shields.io/badge/os-linux-green.svg?style=flat)\n-![Apache 2](https://img.shields.io/badge/license-Apache2-blue.svg?style=flat)\n+### Add dependencies\n \n-## Version Info\n-The latest release of `FileKit` (v0.x.x) runs on Swift 4.0 and newer, on both macOS and Ubuntu Linux\n+Add `FileKit` to the dependencies within your application's `Package.swift` file. Substitute `\"x.x.x\"` with the latest `FileKit` [release](https://github.com/IBM-Swift/FileKit/releases).\n \n-## Installation\n+```swift\n+.package(url: \"https://github.com/IBM-Swift/FileKit.git\", from: \"x.x.x\")\n+```\n+Add `FileKit` to your target's dependencies:\n \n-### Via Swift Package Manager\n+```Swift\n+.target(name: \"example\", dependencies: [\"FileKit\"]),\n+```\n \n-Add `FileKit` to your `Package.swift`:\n+#### Import package\n \n ```swift\n+import FileKit\n+```\n \n-let package = Package(\n-  name: \"<package-name>\",\n-  dependencies: [\n-    // Swift 4\n-    .package(url: \"https://github.com/IBM-Swift/FileKit.git\", .upToNextMajor(from: \"0.0.0\"))\n-  ]\n-)\n+You will also need to import the `Foundation` package if you're handling URLs:\n \n+```swift\n+import Foundation\n ```\n \n ## Supported Paths\n \n #### Path to Executable Folder\n \n-Points to the project executable folder\n+Points to the project executable folder.","path":"README.md","position":78,"original_position":78,"commit_id":"d93b312b65602d0d68904faa09caf50c5a9ba1ad","original_commit_id":"d93b312b65602d0d68904faa09caf50c5a9ba1ad","user":{"login":"djones6","id":17850918,"node_id":"MDQ6VXNlcjE3ODUwOTE4","avatar_url":"https://avatars0.githubusercontent.com/u/17850918?v=4","gravatar_id":"","url":"https://api.github.com/users/djones6","html_url":"https://github.com/djones6","followers_url":"https://api.github.com/users/djones6/followers","following_url":"https://api.github.com/users/djones6/following{/other_user}","gists_url":"https://api.github.com/users/djones6/gists{/gist_id}","starred_url":"https://api.github.com/users/djones6/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/djones6/subscriptions","organizations_url":"https://api.github.com/users/djones6/orgs","repos_url":"https://api.github.com/users/djones6/repos","events_url":"https://api.github.com/users/djones6/events{/privacy}","received_events_url":"https://api.github.com/users/djones6/received_events","type":"User","site_admin":false},"body":"This is a bit vague - could we give a more specific description?  For example, is this the project directory containing the `.build`, or is it literally the location of the executable (eg. `/MyProj/.build/debug/MyProj`)?","created_at":"2018-10-04T08:53:41Z","updated_at":"2018-10-04T08:58:01Z","html_url":"https://github.com/IBM-Swift/FileKit/pull/4#discussion_r222587022","pull_request_url":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/4","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/comments/222587022"},"html":{"href":"https://github.com/IBM-Swift/FileKit/pull/4#discussion_r222587022"},"pull_request":{"href":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/4"}}},"pull_request":{"url":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/4","id":215925557,"node_id":"MDExOlB1bGxSZXF1ZXN0MjE1OTI1NTU3","html_url":"https://github.com/IBM-Swift/FileKit/pull/4","diff_url":"https://github.com/IBM-Swift/FileKit/pull/4.diff","patch_url":"https://github.com/IBM-Swift/FileKit/pull/4.patch","issue_url":"https://api.github.com/repos/IBM-Swift/FileKit/issues/4","number":4,"state":"open","locked":false,"title":"Update documentation","user":{"login":"helenmasters","id":20067264,"node_id":"MDQ6VXNlcjIwMDY3MjY0","avatar_url":"https://avatars0.githubusercontent.com/u/20067264?v=4","gravatar_id":"","url":"https://api.github.com/users/helenmasters","html_url":"https://github.com/helenmasters","followers_url":"https://api.github.com/users/helenmasters/followers","following_url":"https://api.github.com/users/helenmasters/following{/other_user}","gists_url":"https://api.github.com/users/helenmasters/gists{/gist_id}","starred_url":"https://api.github.com/users/helenmasters/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/helenmasters/subscriptions","organizations_url":"https://api.github.com/users/helenmasters/orgs","repos_url":"https://api.github.com/users/helenmasters/repos","events_url":"https://api.github.com/users/helenmasters/events{/privacy}","received_events_url":"https://api.github.com/users/helenmasters/received_events","type":"User","site_admin":false},"body":" - Standardize README header\r\n - Add missing standard README sections\r\n - Add jazzydoc generation to Travis\r\n - Order jazzydoc apis by directory type\r\n - Add usage examples to apidoc","created_at":"2018-09-17T09:51:07Z","updated_at":"2018-10-04T08:58:01Z","closed_at":null,"merged_at":null,"merge_commit_sha":"927e472e50aabc1e4aa4d01ac9709e3cc6ce2253","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/4/commits","review_comments_url":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/4/comments","review_comment_url":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/comments{/number}","comments_url":"https://api.github.com/repos/IBM-Swift/FileKit/issues/4/comments","statuses_url":"https://api.github.com/repos/IBM-Swift/FileKit/statuses/d93b312b65602d0d68904faa09caf50c5a9ba1ad","head":{"label":"IBM-Swift:update_documentation","ref":"update_documentation","sha":"d93b312b65602d0d68904faa09caf50c5a9ba1ad","user":{"login":"IBM-Swift","id":16882981,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE2ODgyOTgx","avatar_url":"https://avatars3.githubusercontent.com/u/16882981?v=4","gravatar_id":"","url":"https://api.github.com/users/IBM-Swift","html_url":"https://github.com/IBM-Swift","followers_url":"https://api.github.com/users/IBM-Swift/followers","following_url":"https://api.github.com/users/IBM-Swift/following{/other_user}","gists_url":"https://api.github.com/users/IBM-Swift/gists{/gist_id}","starred_url":"https://api.github.com/users/IBM-Swift/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IBM-Swift/subscriptions","organizations_url":"https://api.github.com/users/IBM-Swift/orgs","repos_url":"https://api.github.com/users/IBM-Swift/repos","events_url":"https://api.github.com/users/IBM-Swift/events{/privacy}","received_events_url":"https://api.github.com/users/IBM-Swift/received_events","type":"Organization","site_admin":false},"repo":{"id":110873969,"node_id":"MDEwOlJlcG9zaXRvcnkxMTA4NzM5Njk=","name":"FileKit","full_name":"IBM-Swift/FileKit","private":false,"owner":{"login":"IBM-Swift","id":16882981,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE2ODgyOTgx","avatar_url":"https://avatars3.githubusercontent.com/u/16882981?v=4","gravatar_id":"","url":"https://api.github.com/users/IBM-Swift","html_url":"https://github.com/IBM-Swift","followers_url":"https://api.github.com/users/IBM-Swift/followers","following_url":"https://api.github.com/users/IBM-Swift/following{/other_user}","gists_url":"https://api.github.com/users/IBM-Swift/gists{/gist_id}","starred_url":"https://api.github.com/users/IBM-Swift/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IBM-Swift/subscriptions","organizations_url":"https://api.github.com/users/IBM-Swift/orgs","repos_url":"https://api.github.com/users/IBM-Swift/repos","events_url":"https://api.github.com/users/IBM-Swift/events{/privacy}","received_events_url":"https://api.github.com/users/IBM-Swift/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/IBM-Swift/FileKit","description":null,"fork":false,"url":"https://api.github.com/repos/IBM-Swift/FileKit","forks_url":"https://api.github.com/repos/IBM-Swift/FileKit/forks","keys_url":"https://api.github.com/repos/IBM-Swift/FileKit/keys{/key_id}","collaborators_url":"https://api.github.com/repos/IBM-Swift/FileKit/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/IBM-Swift/FileKit/teams","hooks_url":"https://api.github.com/repos/IBM-Swift/FileKit/hooks","issue_events_url":"https://api.github.com/repos/IBM-Swift/FileKit/issues/events{/number}","events_url":"https://api.github.com/repos/IBM-Swift/FileKit/events","assignees_url":"https://api.github.com/repos/IBM-Swift/FileKit/assignees{/user}","branches_url":"https://api.github.com/repos/IBM-Swift/FileKit/branches{/branch}","tags_url":"https://api.github.com/repos/IBM-Swift/FileKit/tags","blobs_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/refs{/sha}","trees_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/trees{/sha}","statuses_url":"https://api.github.com/repos/IBM-Swift/FileKit/statuses/{sha}","languages_url":"https://api.github.com/repos/IBM-Swift/FileKit/languages","stargazers_url":"https://api.github.com/repos/IBM-Swift/FileKit/stargazers","contributors_url":"https://api.github.com/repos/IBM-Swift/FileKit/contributors","subscribers_url":"https://api.github.com/repos/IBM-Swift/FileKit/subscribers","subscription_url":"https://api.github.com/repos/IBM-Swift/FileKit/subscription","commits_url":"https://api.github.com/repos/IBM-Swift/FileKit/commits{/sha}","git_commits_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/commits{/sha}","comments_url":"https://api.github.com/repos/IBM-Swift/FileKit/comments{/number}","issue_comment_url":"https://api.github.com/repos/IBM-Swift/FileKit/issues/comments{/number}","contents_url":"https://api.github.com/repos/IBM-Swift/FileKit/contents/{+path}","compare_url":"https://api.github.com/repos/IBM-Swift/FileKit/compare/{base}...{head}","merges_url":"https://api.github.com/repos/IBM-Swift/FileKit/merges","archive_url":"https://api.github.com/repos/IBM-Swift/FileKit/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/IBM-Swift/FileKit/downloads","issues_url":"https://api.github.com/repos/IBM-Swift/FileKit/issues{/number}","pulls_url":"https://api.github.com/repos/IBM-Swift/FileKit/pulls{/number}","milestones_url":"https://api.github.com/repos/IBM-Swift/FileKit/milestones{/number}","notifications_url":"https://api.github.com/repos/IBM-Swift/FileKit/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/IBM-Swift/FileKit/labels{/name}","releases_url":"https://api.github.com/repos/IBM-Swift/FileKit/releases{/id}","deployments_url":"https://api.github.com/repos/IBM-Swift/FileKit/deployments","created_at":"2017-11-15T18:59:29Z","updated_at":"2018-07-17T14:30:23Z","pushed_at":"2018-09-17T09:51:08Z","git_url":"git://github.com/IBM-Swift/FileKit.git","ssh_url":"git@github.com:IBM-Swift/FileKit.git","clone_url":"https://github.com/IBM-Swift/FileKit.git","svn_url":"https://github.com/IBM-Swift/FileKit","homepage":null,"size":338,"stargazers_count":4,"watchers_count":4,"language":"Swift","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":2,"mirror_url":null,"archived":false,"open_issues_count":1,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":2,"open_issues":1,"watchers":4,"default_branch":"master"}},"base":{"label":"IBM-Swift:master","ref":"master","sha":"335ebf5f61c205ef1b4b5ea02d69794d1d2ec00b","user":{"login":"IBM-Swift","id":16882981,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE2ODgyOTgx","avatar_url":"https://avatars3.githubusercontent.com/u/16882981?v=4","gravatar_id":"","url":"https://api.github.com/users/IBM-Swift","html_url":"https://github.com/IBM-Swift","followers_url":"https://api.github.com/users/IBM-Swift/followers","following_url":"https://api.github.com/users/IBM-Swift/following{/other_user}","gists_url":"https://api.github.com/users/IBM-Swift/gists{/gist_id}","starred_url":"https://api.github.com/users/IBM-Swift/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IBM-Swift/subscriptions","organizations_url":"https://api.github.com/users/IBM-Swift/orgs","repos_url":"https://api.github.com/users/IBM-Swift/repos","events_url":"https://api.github.com/users/IBM-Swift/events{/privacy}","received_events_url":"https://api.github.com/users/IBM-Swift/received_events","type":"Organization","site_admin":false},"repo":{"id":110873969,"node_id":"MDEwOlJlcG9zaXRvcnkxMTA4NzM5Njk=","name":"FileKit","full_name":"IBM-Swift/FileKit","private":false,"owner":{"login":"IBM-Swift","id":16882981,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE2ODgyOTgx","avatar_url":"https://avatars3.githubusercontent.com/u/16882981?v=4","gravatar_id":"","url":"https://api.github.com/users/IBM-Swift","html_url":"https://github.com/IBM-Swift","followers_url":"https://api.github.com/users/IBM-Swift/followers","following_url":"https://api.github.com/users/IBM-Swift/following{/other_user}","gists_url":"https://api.github.com/users/IBM-Swift/gists{/gist_id}","starred_url":"https://api.github.com/users/IBM-Swift/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IBM-Swift/subscriptions","organizations_url":"https://api.github.com/users/IBM-Swift/orgs","repos_url":"https://api.github.com/users/IBM-Swift/repos","events_url":"https://api.github.com/users/IBM-Swift/events{/privacy}","received_events_url":"https://api.github.com/users/IBM-Swift/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/IBM-Swift/FileKit","description":null,"fork":false,"url":"https://api.github.com/repos/IBM-Swift/FileKit","forks_url":"https://api.github.com/repos/IBM-Swift/FileKit/forks","keys_url":"https://api.github.com/repos/IBM-Swift/FileKit/keys{/key_id}","collaborators_url":"https://api.github.com/repos/IBM-Swift/FileKit/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/IBM-Swift/FileKit/teams","hooks_url":"https://api.github.com/repos/IBM-Swift/FileKit/hooks","issue_events_url":"https://api.github.com/repos/IBM-Swift/FileKit/issues/events{/number}","events_url":"https://api.github.com/repos/IBM-Swift/FileKit/events","assignees_url":"https://api.github.com/repos/IBM-Swift/FileKit/assignees{/user}","branches_url":"https://api.github.com/repos/IBM-Swift/FileKit/branches{/branch}","tags_url":"https://api.github.com/repos/IBM-Swift/FileKit/tags","blobs_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/refs{/sha}","trees_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/trees{/sha}","statuses_url":"https://api.github.com/repos/IBM-Swift/FileKit/statuses/{sha}","languages_url":"https://api.github.com/repos/IBM-Swift/FileKit/languages","stargazers_url":"https://api.github.com/repos/IBM-Swift/FileKit/stargazers","contributors_url":"https://api.github.com/repos/IBM-Swift/FileKit/contributors","subscribers_url":"https://api.github.com/repos/IBM-Swift/FileKit/subscribers","subscription_url":"https://api.github.com/repos/IBM-Swift/FileKit/subscription","commits_url":"https://api.github.com/repos/IBM-Swift/FileKit/commits{/sha}","git_commits_url":"https://api.github.com/repos/IBM-Swift/FileKit/git/commits{/sha}","comments_url":"https://api.github.com/repos/IBM-Swift/FileKit/comments{/number}","issue_comment_url":"https://api.github.com/repos/IBM-Swift/FileKit/issues/comments{/number}","contents_url":"https://api.github.com/repos/IBM-Swift/FileKit/contents/{+path}","compare_url":"https://api.github.com/repos/IBM-Swift/FileKit/compare/{base}...{head}","merges_url":"https://api.github.com/repos/IBM-Swift/FileKit/merges","archive_url":"https://api.github.com/repos/IBM-Swift/FileKit/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/IBM-Swift/FileKit/downloads","issues_url":"https://api.github.com/repos/IBM-Swift/FileKit/issues{/number}","pulls_url":"https://api.github.com/repos/IBM-Swift/FileKit/pulls{/number}","milestones_url":"https://api.github.com/repos/IBM-Swift/FileKit/milestones{/number}","notifications_url":"https://api.github.com/repos/IBM-Swift/FileKit/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/IBM-Swift/FileKit/labels{/name}","releases_url":"https://api.github.com/repos/IBM-Swift/FileKit/releases{/id}","deployments_url":"https://api.github.com/repos/IBM-Swift/FileKit/deployments","created_at":"2017-11-15T18:59:29Z","updated_at":"2018-07-17T14:30:23Z","pushed_at":"2018-09-17T09:51:08Z","git_url":"git://github.com/IBM-Swift/FileKit.git","ssh_url":"git@github.com:IBM-Swift/FileKit.git","clone_url":"https://github.com/IBM-Swift/FileKit.git","svn_url":"https://github.com/IBM-Swift/FileKit","homepage":null,"size":338,"stargazers_count":4,"watchers_count":4,"language":"Swift","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":2,"mirror_url":null,"archived":false,"open_issues_count":1,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":2,"open_issues":1,"watchers":4,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/4"},"html":{"href":"https://github.com/IBM-Swift/FileKit/pull/4"},"issue":{"href":"https://api.github.com/repos/IBM-Swift/FileKit/issues/4"},"comments":{"href":"https://api.github.com/repos/IBM-Swift/FileKit/issues/4/comments"},"review_comments":{"href":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/4/comments"},"review_comment":{"href":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/IBM-Swift/FileKit/pulls/4/commits"},"statuses":{"href":"https://api.github.com/repos/IBM-Swift/FileKit/statuses/d93b312b65602d0d68904faa09caf50c5a9ba1ad"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"djones6"}}