{"action":"created","comment":{"url":"https://api.github.com/repos/neovim/lua-client/pulls/comments/75602948","id":75602948,"diff_hunk":"@@ -4,3 +4,190 @@ lua-client\n [![Build Status](https://travis-ci.org/neovim/lua-client.svg?branch=master)](https://travis-ci.org/neovim/lua-client)\n \n Lua client for Neovim\n+\n+\n+Basic usage\n+-----------\n+\n+The module `nvim.nvim` provides a set of functions to connect to an instance of neovim.\n+\n+### Create an instance of the client\n+\n+First of all we need to get an instance of the client ready to talk with neovim.\n+\n+#### new_from_socket_file\n+\n+Connects into a running neovim instance using a socket file stream.\n+\n+```lua\n+local Nvim = require('nvim.nvim')\n+local nvim = Nvim.new_from_socket_file('/tmp/.nvim.socket')\n+```\n+\n+#### new_from_socket\n+\n+Connects into a running neovim instance using a socket tcp stream.\n+\n+```lua\n+local Nvim = require('nvim.nvim')\n+local nvim = Nvim.new_from_socket('127.0.0.1', 6666)\n+```\n+\n+#### new_from_process\n+\n+```lua\n+local Nvim = require('nvim.nvim')\n+local nvim = Nvim.new_from_process()\n+```\n+\n+This code will create a new embedded neovim instance and will connect into it.","path":"README.md","position":40,"original_position":40,"commit_id":"9ed18cbbb2b088a73b13024be01ea7b686240f24","original_commit_id":"9ed18cbbb2b088a73b13024be01ea7b686240f24","user":{"login":"brcolow","id":6589866,"avatar_url":"https://avatars.githubusercontent.com/u/6589866?v=3","gravatar_id":"","url":"https://api.github.com/users/brcolow","html_url":"https://github.com/brcolow","followers_url":"https://api.github.com/users/brcolow/followers","following_url":"https://api.github.com/users/brcolow/following{/other_user}","gists_url":"https://api.github.com/users/brcolow/gists{/gist_id}","starred_url":"https://api.github.com/users/brcolow/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/brcolow/subscriptions","organizations_url":"https://api.github.com/users/brcolow/orgs","repos_url":"https://api.github.com/users/brcolow/repos","events_url":"https://api.github.com/users/brcolow/events{/privacy}","received_events_url":"https://api.github.com/users/brcolow/received_events","type":"User","site_admin":false},"body":"same here.","created_at":"2016-08-21T20:42:17Z","updated_at":"2016-08-21T20:42:17Z","html_url":"https://github.com/neovim/lua-client/pull/28#discussion_r75602948","pull_request_url":"https://api.github.com/repos/neovim/lua-client/pulls/28","_links":{"self":{"href":"https://api.github.com/repos/neovim/lua-client/pulls/comments/75602948"},"html":{"href":"https://github.com/neovim/lua-client/pull/28#discussion_r75602948"},"pull_request":{"href":"https://api.github.com/repos/neovim/lua-client/pulls/28"}}},"pull_request":{"url":"https://api.github.com/repos/neovim/lua-client/pulls/28","id":73118511,"html_url":"https://github.com/neovim/lua-client/pull/28","diff_url":"https://github.com/neovim/lua-client/pull/28.diff","patch_url":"https://github.com/neovim/lua-client/pull/28.patch","issue_url":"https://api.github.com/repos/neovim/lua-client/issues/28","number":28,"state":"open","locked":false,"title":"Lua high level client","user":{"login":"AitorATuin","id":1757663,"avatar_url":"https://avatars.githubusercontent.com/u/1757663?v=3","gravatar_id":"","url":"https://api.github.com/users/AitorATuin","html_url":"https://github.com/AitorATuin","followers_url":"https://api.github.com/users/AitorATuin/followers","following_url":"https://api.github.com/users/AitorATuin/following{/other_user}","gists_url":"https://api.github.com/users/AitorATuin/gists{/gist_id}","starred_url":"https://api.github.com/users/AitorATuin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AitorATuin/subscriptions","organizations_url":"https://api.github.com/users/AitorATuin/orgs","repos_url":"https://api.github.com/users/AitorATuin/repos","events_url":"https://api.github.com/users/AitorATuin/events{/privacy}","received_events_url":"https://api.github.com/users/AitorATuin/received_events","type":"User","site_admin":false},"body":"","created_at":"2016-06-08T20:54:20Z","updated_at":"2016-08-21T20:42:17Z","closed_at":null,"merged_at":null,"merge_commit_sha":"4d3a8cc866891ad91af9611df3da5d7d9ba69a4a","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/neovim/lua-client/pulls/28/commits","review_comments_url":"https://api.github.com/repos/neovim/lua-client/pulls/28/comments","review_comment_url":"https://api.github.com/repos/neovim/lua-client/pulls/comments{/number}","comments_url":"https://api.github.com/repos/neovim/lua-client/issues/28/comments","statuses_url":"https://api.github.com/repos/neovim/lua-client/statuses/9ed18cbbb2b088a73b13024be01ea7b686240f24","head":{"label":"AitorATuin:client","ref":"client","sha":"9ed18cbbb2b088a73b13024be01ea7b686240f24","user":{"login":"AitorATuin","id":1757663,"avatar_url":"https://avatars.githubusercontent.com/u/1757663?v=3","gravatar_id":"","url":"https://api.github.com/users/AitorATuin","html_url":"https://github.com/AitorATuin","followers_url":"https://api.github.com/users/AitorATuin/followers","following_url":"https://api.github.com/users/AitorATuin/following{/other_user}","gists_url":"https://api.github.com/users/AitorATuin/gists{/gist_id}","starred_url":"https://api.github.com/users/AitorATuin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AitorATuin/subscriptions","organizations_url":"https://api.github.com/users/AitorATuin/orgs","repos_url":"https://api.github.com/users/AitorATuin/repos","events_url":"https://api.github.com/users/AitorATuin/events{/privacy}","received_events_url":"https://api.github.com/users/AitorATuin/received_events","type":"User","site_admin":false},"repo":{"id":54419331,"name":"lua-client","full_name":"AitorATuin/lua-client","owner":{"login":"AitorATuin","id":1757663,"avatar_url":"https://avatars.githubusercontent.com/u/1757663?v=3","gravatar_id":"","url":"https://api.github.com/users/AitorATuin","html_url":"https://github.com/AitorATuin","followers_url":"https://api.github.com/users/AitorATuin/followers","following_url":"https://api.github.com/users/AitorATuin/following{/other_user}","gists_url":"https://api.github.com/users/AitorATuin/gists{/gist_id}","starred_url":"https://api.github.com/users/AitorATuin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AitorATuin/subscriptions","organizations_url":"https://api.github.com/users/AitorATuin/orgs","repos_url":"https://api.github.com/users/AitorATuin/repos","events_url":"https://api.github.com/users/AitorATuin/events{/privacy}","received_events_url":"https://api.github.com/users/AitorATuin/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/AitorATuin/lua-client","description":"Lua client for Neovim","fork":true,"url":"https://api.github.com/repos/AitorATuin/lua-client","forks_url":"https://api.github.com/repos/AitorATuin/lua-client/forks","keys_url":"https://api.github.com/repos/AitorATuin/lua-client/keys{/key_id}","collaborators_url":"https://api.github.com/repos/AitorATuin/lua-client/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/AitorATuin/lua-client/teams","hooks_url":"https://api.github.com/repos/AitorATuin/lua-client/hooks","issue_events_url":"https://api.github.com/repos/AitorATuin/lua-client/issues/events{/number}","events_url":"https://api.github.com/repos/AitorATuin/lua-client/events","assignees_url":"https://api.github.com/repos/AitorATuin/lua-client/assignees{/user}","branches_url":"https://api.github.com/repos/AitorATuin/lua-client/branches{/branch}","tags_url":"https://api.github.com/repos/AitorATuin/lua-client/tags","blobs_url":"https://api.github.com/repos/AitorATuin/lua-client/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/AitorATuin/lua-client/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/AitorATuin/lua-client/git/refs{/sha}","trees_url":"https://api.github.com/repos/AitorATuin/lua-client/git/trees{/sha}","statuses_url":"https://api.github.com/repos/AitorATuin/lua-client/statuses/{sha}","languages_url":"https://api.github.com/repos/AitorATuin/lua-client/languages","stargazers_url":"https://api.github.com/repos/AitorATuin/lua-client/stargazers","contributors_url":"https://api.github.com/repos/AitorATuin/lua-client/contributors","subscribers_url":"https://api.github.com/repos/AitorATuin/lua-client/subscribers","subscription_url":"https://api.github.com/repos/AitorATuin/lua-client/subscription","commits_url":"https://api.github.com/repos/AitorATuin/lua-client/commits{/sha}","git_commits_url":"https://api.github.com/repos/AitorATuin/lua-client/git/commits{/sha}","comments_url":"https://api.github.com/repos/AitorATuin/lua-client/comments{/number}","issue_comment_url":"https://api.github.com/repos/AitorATuin/lua-client/issues/comments{/number}","contents_url":"https://api.github.com/repos/AitorATuin/lua-client/contents/{+path}","compare_url":"https://api.github.com/repos/AitorATuin/lua-client/compare/{base}...{head}","merges_url":"https://api.github.com/repos/AitorATuin/lua-client/merges","archive_url":"https://api.github.com/repos/AitorATuin/lua-client/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/AitorATuin/lua-client/downloads","issues_url":"https://api.github.com/repos/AitorATuin/lua-client/issues{/number}","pulls_url":"https://api.github.com/repos/AitorATuin/lua-client/pulls{/number}","milestones_url":"https://api.github.com/repos/AitorATuin/lua-client/milestones{/number}","notifications_url":"https://api.github.com/repos/AitorATuin/lua-client/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/AitorATuin/lua-client/labels{/name}","releases_url":"https://api.github.com/repos/AitorATuin/lua-client/releases{/id}","deployments_url":"https://api.github.com/repos/AitorATuin/lua-client/deployments","created_at":"2016-03-21T20:11:20Z","updated_at":"2016-03-21T20:11:21Z","pushed_at":"2016-08-21T20:37:07Z","git_url":"git://github.com/AitorATuin/lua-client.git","ssh_url":"git@github.com:AitorATuin/lua-client.git","clone_url":"https://github.com/AitorATuin/lua-client.git","svn_url":"https://github.com/AitorATuin/lua-client","homepage":null,"size":91,"stargazers_count":0,"watchers_count":0,"language":"Lua","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"neovim:master","ref":"master","sha":"1fcc9572c7981bf21482b52be4d1e67d467caca2","user":{"login":"neovim","id":6471485,"avatar_url":"https://avatars.githubusercontent.com/u/6471485?v=3","gravatar_id":"","url":"https://api.github.com/users/neovim","html_url":"https://github.com/neovim","followers_url":"https://api.github.com/users/neovim/followers","following_url":"https://api.github.com/users/neovim/following{/other_user}","gists_url":"https://api.github.com/users/neovim/gists{/gist_id}","starred_url":"https://api.github.com/users/neovim/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/neovim/subscriptions","organizations_url":"https://api.github.com/users/neovim/orgs","repos_url":"https://api.github.com/users/neovim/repos","events_url":"https://api.github.com/users/neovim/events{/privacy}","received_events_url":"https://api.github.com/users/neovim/received_events","type":"Organization","site_admin":false},"repo":{"id":23454816,"name":"lua-client","full_name":"neovim/lua-client","owner":{"login":"neovim","id":6471485,"avatar_url":"https://avatars.githubusercontent.com/u/6471485?v=3","gravatar_id":"","url":"https://api.github.com/users/neovim","html_url":"https://github.com/neovim","followers_url":"https://api.github.com/users/neovim/followers","following_url":"https://api.github.com/users/neovim/following{/other_user}","gists_url":"https://api.github.com/users/neovim/gists{/gist_id}","starred_url":"https://api.github.com/users/neovim/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/neovim/subscriptions","organizations_url":"https://api.github.com/users/neovim/orgs","repos_url":"https://api.github.com/users/neovim/repos","events_url":"https://api.github.com/users/neovim/events{/privacy}","received_events_url":"https://api.github.com/users/neovim/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/neovim/lua-client","description":"Lua client for Neovim","fork":false,"url":"https://api.github.com/repos/neovim/lua-client","forks_url":"https://api.github.com/repos/neovim/lua-client/forks","keys_url":"https://api.github.com/repos/neovim/lua-client/keys{/key_id}","collaborators_url":"https://api.github.com/repos/neovim/lua-client/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/neovim/lua-client/teams","hooks_url":"https://api.github.com/repos/neovim/lua-client/hooks","issue_events_url":"https://api.github.com/repos/neovim/lua-client/issues/events{/number}","events_url":"https://api.github.com/repos/neovim/lua-client/events","assignees_url":"https://api.github.com/repos/neovim/lua-client/assignees{/user}","branches_url":"https://api.github.com/repos/neovim/lua-client/branches{/branch}","tags_url":"https://api.github.com/repos/neovim/lua-client/tags","blobs_url":"https://api.github.com/repos/neovim/lua-client/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/neovim/lua-client/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/neovim/lua-client/git/refs{/sha}","trees_url":"https://api.github.com/repos/neovim/lua-client/git/trees{/sha}","statuses_url":"https://api.github.com/repos/neovim/lua-client/statuses/{sha}","languages_url":"https://api.github.com/repos/neovim/lua-client/languages","stargazers_url":"https://api.github.com/repos/neovim/lua-client/stargazers","contributors_url":"https://api.github.com/repos/neovim/lua-client/contributors","subscribers_url":"https://api.github.com/repos/neovim/lua-client/subscribers","subscription_url":"https://api.github.com/repos/neovim/lua-client/subscription","commits_url":"https://api.github.com/repos/neovim/lua-client/commits{/sha}","git_commits_url":"https://api.github.com/repos/neovim/lua-client/git/commits{/sha}","comments_url":"https://api.github.com/repos/neovim/lua-client/comments{/number}","issue_comment_url":"https://api.github.com/repos/neovim/lua-client/issues/comments{/number}","contents_url":"https://api.github.com/repos/neovim/lua-client/contents/{+path}","compare_url":"https://api.github.com/repos/neovim/lua-client/compare/{base}...{head}","merges_url":"https://api.github.com/repos/neovim/lua-client/merges","archive_url":"https://api.github.com/repos/neovim/lua-client/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/neovim/lua-client/downloads","issues_url":"https://api.github.com/repos/neovim/lua-client/issues{/number}","pulls_url":"https://api.github.com/repos/neovim/lua-client/pulls{/number}","milestones_url":"https://api.github.com/repos/neovim/lua-client/milestones{/number}","notifications_url":"https://api.github.com/repos/neovim/lua-client/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/neovim/lua-client/labels{/name}","releases_url":"https://api.github.com/repos/neovim/lua-client/releases{/id}","deployments_url":"https://api.github.com/repos/neovim/lua-client/deployments","created_at":"2014-08-29T06:29:27Z","updated_at":"2016-07-25T16:18:39Z","pushed_at":"2016-08-21T20:37:08Z","git_url":"git://github.com/neovim/lua-client.git","ssh_url":"git@github.com:neovim/lua-client.git","clone_url":"https://github.com/neovim/lua-client.git","svn_url":"https://github.com/neovim/lua-client","homepage":null,"size":101,"stargazers_count":36,"watchers_count":36,"language":"Lua","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":13,"mirror_url":null,"open_issues_count":2,"forks":13,"open_issues":2,"watchers":36,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/neovim/lua-client/pulls/28"},"html":{"href":"https://github.com/neovim/lua-client/pull/28"},"issue":{"href":"https://api.github.com/repos/neovim/lua-client/issues/28"},"comments":{"href":"https://api.github.com/repos/neovim/lua-client/issues/28/comments"},"review_comments":{"href":"https://api.github.com/repos/neovim/lua-client/pulls/28/comments"},"review_comment":{"href":"https://api.github.com/repos/neovim/lua-client/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/neovim/lua-client/pulls/28/commits"},"statuses":{"href":"https://api.github.com/repos/neovim/lua-client/statuses/9ed18cbbb2b088a73b13024be01ea7b686240f24"}}}}
{"actor":{"display_login":"brcolow"}}