{"action":"created","comment":{"url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/comments/26913426","id":26913426,"diff_hunk":"@@ -5,14 +5,37 @@ Firefox Accounts DB Server\n \n ## Usage\n \n+If you would like to run a FxA Auth DB Server, then you probably want to look at the\n+[Fxa Auth DB MySql](http://github.com/mozilla/fxa-auth-db-mysql/) repo (for production usage) or the\n+[Fxa Auth DB Mem](http://github.com/mozilla/fxa-auth-db-mem/) repo (for testing purposes). Each of these repos\n+implement a storage backend and will install this repo when you run `npm install` since they each import the server\n+from here.\n+\n+## Usage\n+\n ```js\n-var createServer = require('fxa-auth-db-server')\n-var database = require('./db') // An object the implements the DB API described below\n+// Require the dbServer. This includes dbServer.createServer() and the dbServer.errors object.\n+var dbServer = require('fxa-auth-db-server')\n+\n+// require the database engine and pass it a logger and the dbServer.errors","path":"README.md","position":18,"original_position":18,"commit_id":"4da2c4064c23c81e5fb161651c5d95ea7d0227c9","original_commit_id":"4da2c4064c23c81e5fb161651c5d95ea7d0227c9","user":{"login":"pdehaan","id":557895,"avatar_url":"https://avatars.githubusercontent.com/u/557895?v=3","gravatar_id":"","url":"https://api.github.com/users/pdehaan","html_url":"https://github.com/pdehaan","followers_url":"https://api.github.com/users/pdehaan/followers","following_url":"https://api.github.com/users/pdehaan/following{/other_user}","gists_url":"https://api.github.com/users/pdehaan/gists{/gist_id}","starred_url":"https://api.github.com/users/pdehaan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pdehaan/subscriptions","organizations_url":"https://api.github.com/users/pdehaan/orgs","repos_url":"https://api.github.com/users/pdehaan/repos","events_url":"https://api.github.com/users/pdehaan/events{/privacy}","received_events_url":"https://api.github.com/users/pdehaan/received_events","type":"User","site_admin":false},"body":"What is \"and pass it a logger and the `dbServer.errors`\" here?\r\nI only see a lowly `require()` in the following line (but we do pass a `dbServer.errors` instance down below on L24.","created_at":"2015-03-23T03:58:33Z","updated_at":"2015-03-23T03:58:33Z","html_url":"https://github.com/mozilla/fxa-auth-db-server/pull/129#discussion_r26913426","pull_request_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/129","_links":{"self":{"href":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/comments/26913426"},"html":{"href":"https://github.com/mozilla/fxa-auth-db-server/pull/129#discussion_r26913426"},"pull_request":{"href":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/129"}}},"pull_request":{"url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/129","id":31700383,"html_url":"https://github.com/mozilla/fxa-auth-db-server/pull/129","diff_url":"https://github.com/mozilla/fxa-auth-db-server/pull/129.diff","patch_url":"https://github.com/mozilla/fxa-auth-db-server/pull/129.patch","issue_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/issues/129","number":129,"state":"open","locked":false,"title":"docs(readme): better readme for help implementing a storage backend","user":{"login":"chilts","id":3048,"avatar_url":"https://avatars.githubusercontent.com/u/3048?v=3","gravatar_id":"","url":"https://api.github.com/users/chilts","html_url":"https://github.com/chilts","followers_url":"https://api.github.com/users/chilts/followers","following_url":"https://api.github.com/users/chilts/following{/other_user}","gists_url":"https://api.github.com/users/chilts/gists{/gist_id}","starred_url":"https://api.github.com/users/chilts/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chilts/subscriptions","organizations_url":"https://api.github.com/users/chilts/orgs","repos_url":"https://api.github.com/users/chilts/repos","events_url":"https://api.github.com/users/chilts/events{/privacy}","received_events_url":"https://api.github.com/users/chilts/received_events","type":"User","site_admin":false},"body":"This adds a better example of using this repo as well as a pointer to the mem and mysql backends for users just trying it out. A link to the DB API has also been added.\r\n","created_at":"2015-03-23T01:57:19Z","updated_at":"2015-03-23T03:58:33Z","closed_at":null,"merged_at":null,"merge_commit_sha":"aa183dd7017d492ee3781c96978899683a6ce793","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/129/commits","review_comments_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/129/comments","review_comment_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/comments{/number}","comments_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/issues/129/comments","statuses_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/statuses/4da2c4064c23c81e5fb161651c5d95ea7d0227c9","head":{"label":"chilts:more-detailed-readme","ref":"more-detailed-readme","sha":"4da2c4064c23c81e5fb161651c5d95ea7d0227c9","user":{"login":"chilts","id":3048,"avatar_url":"https://avatars.githubusercontent.com/u/3048?v=3","gravatar_id":"","url":"https://api.github.com/users/chilts","html_url":"https://github.com/chilts","followers_url":"https://api.github.com/users/chilts/followers","following_url":"https://api.github.com/users/chilts/following{/other_user}","gists_url":"https://api.github.com/users/chilts/gists{/gist_id}","starred_url":"https://api.github.com/users/chilts/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chilts/subscriptions","organizations_url":"https://api.github.com/users/chilts/orgs","repos_url":"https://api.github.com/users/chilts/repos","events_url":"https://api.github.com/users/chilts/events{/privacy}","received_events_url":"https://api.github.com/users/chilts/received_events","type":"User","site_admin":false},"repo":{"id":19474884,"name":"fxa-auth-db-server","full_name":"chilts/fxa-auth-db-server","owner":{"login":"chilts","id":3048,"avatar_url":"https://avatars.githubusercontent.com/u/3048?v=3","gravatar_id":"","url":"https://api.github.com/users/chilts","html_url":"https://github.com/chilts","followers_url":"https://api.github.com/users/chilts/followers","following_url":"https://api.github.com/users/chilts/following{/other_user}","gists_url":"https://api.github.com/users/chilts/gists{/gist_id}","starred_url":"https://api.github.com/users/chilts/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chilts/subscriptions","organizations_url":"https://api.github.com/users/chilts/orgs","repos_url":"https://api.github.com/users/chilts/repos","events_url":"https://api.github.com/users/chilts/events{/privacy}","received_events_url":"https://api.github.com/users/chilts/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/chilts/fxa-auth-db-server","description":"Database layer for Firefox Accounts.","fork":true,"url":"https://api.github.com/repos/chilts/fxa-auth-db-server","forks_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/forks","keys_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/keys{/key_id}","collaborators_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/teams","hooks_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/hooks","issue_events_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/issues/events{/number}","events_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/events","assignees_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/assignees{/user}","branches_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/branches{/branch}","tags_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/tags","blobs_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/git/refs{/sha}","trees_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/git/trees{/sha}","statuses_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/statuses/{sha}","languages_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/languages","stargazers_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/stargazers","contributors_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/contributors","subscribers_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/subscribers","subscription_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/subscription","commits_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/commits{/sha}","git_commits_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/git/commits{/sha}","comments_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/comments{/number}","issue_comment_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/issues/comments{/number}","contents_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/contents/{+path}","compare_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/compare/{base}...{head}","merges_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/merges","archive_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/downloads","issues_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/issues{/number}","pulls_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/pulls{/number}","milestones_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/milestones{/number}","notifications_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/labels{/name}","releases_url":"https://api.github.com/repos/chilts/fxa-auth-db-server/releases{/id}","created_at":"2014-05-05T23:42:09Z","updated_at":"2015-03-22T21:49:50Z","pushed_at":"2015-03-23T01:56:52Z","git_url":"git://github.com/chilts/fxa-auth-db-server.git","ssh_url":"git@github.com:chilts/fxa-auth-db-server.git","clone_url":"https://github.com/chilts/fxa-auth-db-server.git","svn_url":"https://github.com/chilts/fxa-auth-db-server","homepage":"","size":985,"stargazers_count":0,"watchers_count":0,"language":"JavaScript","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":1,"forks":0,"open_issues":1,"watchers":0,"default_branch":"master"}},"base":{"label":"mozilla:master","ref":"master","sha":"f3d111b3f895a4f6c9bb76efc80e505b52eed074","user":{"login":"mozilla","id":131524,"avatar_url":"https://avatars.githubusercontent.com/u/131524?v=3","gravatar_id":"","url":"https://api.github.com/users/mozilla","html_url":"https://github.com/mozilla","followers_url":"https://api.github.com/users/mozilla/followers","following_url":"https://api.github.com/users/mozilla/following{/other_user}","gists_url":"https://api.github.com/users/mozilla/gists{/gist_id}","starred_url":"https://api.github.com/users/mozilla/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mozilla/subscriptions","organizations_url":"https://api.github.com/users/mozilla/orgs","repos_url":"https://api.github.com/users/mozilla/repos","events_url":"https://api.github.com/users/mozilla/events{/privacy}","received_events_url":"https://api.github.com/users/mozilla/received_events","type":"Organization","site_admin":false},"repo":{"id":18712343,"name":"fxa-auth-db-server","full_name":"mozilla/fxa-auth-db-server","owner":{"login":"mozilla","id":131524,"avatar_url":"https://avatars.githubusercontent.com/u/131524?v=3","gravatar_id":"","url":"https://api.github.com/users/mozilla","html_url":"https://github.com/mozilla","followers_url":"https://api.github.com/users/mozilla/followers","following_url":"https://api.github.com/users/mozilla/following{/other_user}","gists_url":"https://api.github.com/users/mozilla/gists{/gist_id}","starred_url":"https://api.github.com/users/mozilla/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mozilla/subscriptions","organizations_url":"https://api.github.com/users/mozilla/orgs","repos_url":"https://api.github.com/users/mozilla/repos","events_url":"https://api.github.com/users/mozilla/events{/privacy}","received_events_url":"https://api.github.com/users/mozilla/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/mozilla/fxa-auth-db-server","description":"database layer for Firefox Accounts server","fork":false,"url":"https://api.github.com/repos/mozilla/fxa-auth-db-server","forks_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/forks","keys_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/teams","hooks_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/hooks","issue_events_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/issues/events{/number}","events_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/events","assignees_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/assignees{/user}","branches_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/branches{/branch}","tags_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/tags","blobs_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/git/refs{/sha}","trees_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/statuses/{sha}","languages_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/languages","stargazers_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/stargazers","contributors_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/contributors","subscribers_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/subscribers","subscription_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/subscription","commits_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/commits{/sha}","git_commits_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/git/commits{/sha}","comments_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/comments{/number}","issue_comment_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/issues/comments{/number}","contents_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/contents/{+path}","compare_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/merges","archive_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/downloads","issues_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/issues{/number}","pulls_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls{/number}","milestones_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/milestones{/number}","notifications_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/labels{/name}","releases_url":"https://api.github.com/repos/mozilla/fxa-auth-db-server/releases{/id}","created_at":"2014-04-12T19:13:39Z","updated_at":"2015-03-17T03:02:05Z","pushed_at":"2015-03-23T01:57:19Z","git_url":"git://github.com/mozilla/fxa-auth-db-server.git","ssh_url":"git@github.com:mozilla/fxa-auth-db-server.git","clone_url":"https://github.com/mozilla/fxa-auth-db-server.git","svn_url":"https://github.com/mozilla/fxa-auth-db-server","homepage":"","size":1168,"stargazers_count":3,"watchers_count":3,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":9,"mirror_url":null,"open_issues_count":13,"forks":9,"open_issues":13,"watchers":3,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/129"},"html":{"href":"https://github.com/mozilla/fxa-auth-db-server/pull/129"},"issue":{"href":"https://api.github.com/repos/mozilla/fxa-auth-db-server/issues/129"},"comments":{"href":"https://api.github.com/repos/mozilla/fxa-auth-db-server/issues/129/comments"},"review_comments":{"href":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/129/comments"},"review_comment":{"href":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/mozilla/fxa-auth-db-server/pulls/129/commits"},"statuses":{"href":"https://api.github.com/repos/mozilla/fxa-auth-db-server/statuses/4da2c4064c23c81e5fb161651c5d95ea7d0227c9"}}}}