{"action":"created","comment":{"url":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/comments/165976229","pull_request_review_id":93994183,"id":165976229,"diff_hunk":"@@ -24,47 +24,105 @@ TODO\n  - `npm install --save k-simple-state`\n \n ## API\n+### createStore(<store_description>, \\<options>)\n+| parameter | required | description |\n+|---|---|---|\n+| <store_description>| required | object describing your store, it can be nested |\n+| [\\<options>](#options) | optional | all options you may want to override |\n+\n+#### options\n+All options are optionals to keep the default usage as simple as possible.\n+\n+| key | type | default | description |\n+|---|---|---|---|\n+| listeners | `array` | `undefined` | array of all listeners. Listeners are a big part of this lib, you can [click here for detail](#TODO). |\n+| devtools | `boolean` | `true` | [redux-devtools](https://github.com/zalmoxisus/redux-devtools-extension) is activated. |\n+| hideRedux | `boolean` | `true` | actions and selectors from [`k-redux-factory`](https://github.com/alakarteio/k-redux-factory) are used without specifying `dispatch` or `getState`. |\n+| enhancer | redux enhancer | `undefined` | usual `compose` and `applyMiddlare` you already use with Redux can be injected here (like router, redux-saga, etc). <br />`compose` and `applyMiddleware` from Redux are exposed by the lib. To use them:<br /> ```import { compose, applyMiddleware } from 'k-simple-state'```. |\n+| init | `object` | `undefined` | the default value of your store. |\n+\n+#### listeners\n TODO\n \n ## Examples\n-Full example\n-```es6\n-const { createState } = require('k-simple-state')\n+### Simple one, with k-redux-factory\n+```js\n+import { createStore } from 'k-simple-state'\n \n-const saveToLocalStorage = store => next => (action) => {\n-  // dispatch action\n-  const res = next(action)\n+// create a store of todos\n+const store = createStore({\n+  todos: { type: 'keyValue', key: 'id' },","path":"README.md","position":37,"original_position":37,"commit_id":"c9f65306294a4cfad2867771aa57c81a78710557","original_commit_id":"c9f65306294a4cfad2867771aa57c81a78710557","user":{"login":"fabienjuif","id":17828231,"avatar_url":"https://avatars0.githubusercontent.com/u/17828231?v=4","gravatar_id":"","url":"https://api.github.com/users/fabienjuif","html_url":"https://github.com/fabienjuif","followers_url":"https://api.github.com/users/fabienjuif/followers","following_url":"https://api.github.com/users/fabienjuif/following{/other_user}","gists_url":"https://api.github.com/users/fabienjuif/gists{/gist_id}","starred_url":"https://api.github.com/users/fabienjuif/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/fabienjuif/subscriptions","organizations_url":"https://api.github.com/users/fabienjuif/orgs","repos_url":"https://api.github.com/users/fabienjuif/repos","events_url":"https://api.github.com/users/fabienjuif/events{/privacy}","received_events_url":"https://api.github.com/users/fabienjuif/received_events","type":"User","site_admin":false},"body":"Yes you guess right ;)","created_at":"2018-02-05T13:50:47Z","updated_at":"2018-02-05T13:50:47Z","html_url":"https://github.com/alakarteio/k-simple-state/pull/48#discussion_r165976229","pull_request_url":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/48","author_association":"OWNER","_links":{"self":{"href":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/comments/165976229"},"html":{"href":"https://github.com/alakarteio/k-simple-state/pull/48#discussion_r165976229"},"pull_request":{"href":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/48"}},"in_reply_to_id":165961282},"pull_request":{"url":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/48","id":167012219,"html_url":"https://github.com/alakarteio/k-simple-state/pull/48","diff_url":"https://github.com/alakarteio/k-simple-state/pull/48.diff","patch_url":"https://github.com/alakarteio/k-simple-state/pull/48.patch","issue_url":"https://api.github.com/repos/alakarteio/k-simple-state/issues/48","number":48,"state":"open","locked":false,"title":":memo: documentation","user":{"login":"fabienjuif","id":17828231,"avatar_url":"https://avatars0.githubusercontent.com/u/17828231?v=4","gravatar_id":"","url":"https://api.github.com/users/fabienjuif","html_url":"https://github.com/fabienjuif","followers_url":"https://api.github.com/users/fabienjuif/followers","following_url":"https://api.github.com/users/fabienjuif/following{/other_user}","gists_url":"https://api.github.com/users/fabienjuif/gists{/gist_id}","starred_url":"https://api.github.com/users/fabienjuif/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/fabienjuif/subscriptions","organizations_url":"https://api.github.com/users/fabienjuif/orgs","repos_url":"https://api.github.com/users/fabienjuif/repos","events_url":"https://api.github.com/users/fabienjuif/events{/privacy}","received_events_url":"https://api.github.com/users/fabienjuif/received_events","type":"User","site_admin":false},"body":"fixes #3 \r\n\r\ncan be seen here: https://github.com/alakarteio/k-simple-state/blob/doc/README.md","created_at":"2018-02-04T14:23:06Z","updated_at":"2018-02-05T13:50:47Z","closed_at":null,"merged_at":null,"merge_commit_sha":"bf765dbe60b9c9897dae574d46146e4c99090713","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"milestone":null,"commits_url":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/48/commits","review_comments_url":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/48/comments","review_comment_url":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/comments{/number}","comments_url":"https://api.github.com/repos/alakarteio/k-simple-state/issues/48/comments","statuses_url":"https://api.github.com/repos/alakarteio/k-simple-state/statuses/c9f65306294a4cfad2867771aa57c81a78710557","head":{"label":"alakarteio:doc","ref":"doc","sha":"c9f65306294a4cfad2867771aa57c81a78710557","user":{"login":"alakarteio","id":26111459,"avatar_url":"https://avatars2.githubusercontent.com/u/26111459?v=4","gravatar_id":"","url":"https://api.github.com/users/alakarteio","html_url":"https://github.com/alakarteio","followers_url":"https://api.github.com/users/alakarteio/followers","following_url":"https://api.github.com/users/alakarteio/following{/other_user}","gists_url":"https://api.github.com/users/alakarteio/gists{/gist_id}","starred_url":"https://api.github.com/users/alakarteio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alakarteio/subscriptions","organizations_url":"https://api.github.com/users/alakarteio/orgs","repos_url":"https://api.github.com/users/alakarteio/repos","events_url":"https://api.github.com/users/alakarteio/events{/privacy}","received_events_url":"https://api.github.com/users/alakarteio/received_events","type":"Organization","site_admin":false},"repo":{"id":117885088,"name":"k-simple-state","full_name":"alakarteio/k-simple-state","owner":{"login":"alakarteio","id":26111459,"avatar_url":"https://avatars2.githubusercontent.com/u/26111459?v=4","gravatar_id":"","url":"https://api.github.com/users/alakarteio","html_url":"https://github.com/alakarteio","followers_url":"https://api.github.com/users/alakarteio/followers","following_url":"https://api.github.com/users/alakarteio/following{/other_user}","gists_url":"https://api.github.com/users/alakarteio/gists{/gist_id}","starred_url":"https://api.github.com/users/alakarteio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alakarteio/subscriptions","organizations_url":"https://api.github.com/users/alakarteio/orgs","repos_url":"https://api.github.com/users/alakarteio/repos","events_url":"https://api.github.com/users/alakarteio/events{/privacy}","received_events_url":"https://api.github.com/users/alakarteio/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/alakarteio/k-simple-state","description":"State manager for you components apps, the safe and easy way.","fork":false,"url":"https://api.github.com/repos/alakarteio/k-simple-state","forks_url":"https://api.github.com/repos/alakarteio/k-simple-state/forks","keys_url":"https://api.github.com/repos/alakarteio/k-simple-state/keys{/key_id}","collaborators_url":"https://api.github.com/repos/alakarteio/k-simple-state/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/alakarteio/k-simple-state/teams","hooks_url":"https://api.github.com/repos/alakarteio/k-simple-state/hooks","issue_events_url":"https://api.github.com/repos/alakarteio/k-simple-state/issues/events{/number}","events_url":"https://api.github.com/repos/alakarteio/k-simple-state/events","assignees_url":"https://api.github.com/repos/alakarteio/k-simple-state/assignees{/user}","branches_url":"https://api.github.com/repos/alakarteio/k-simple-state/branches{/branch}","tags_url":"https://api.github.com/repos/alakarteio/k-simple-state/tags","blobs_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/refs{/sha}","trees_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/trees{/sha}","statuses_url":"https://api.github.com/repos/alakarteio/k-simple-state/statuses/{sha}","languages_url":"https://api.github.com/repos/alakarteio/k-simple-state/languages","stargazers_url":"https://api.github.com/repos/alakarteio/k-simple-state/stargazers","contributors_url":"https://api.github.com/repos/alakarteio/k-simple-state/contributors","subscribers_url":"https://api.github.com/repos/alakarteio/k-simple-state/subscribers","subscription_url":"https://api.github.com/repos/alakarteio/k-simple-state/subscription","commits_url":"https://api.github.com/repos/alakarteio/k-simple-state/commits{/sha}","git_commits_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/commits{/sha}","comments_url":"https://api.github.com/repos/alakarteio/k-simple-state/comments{/number}","issue_comment_url":"https://api.github.com/repos/alakarteio/k-simple-state/issues/comments{/number}","contents_url":"https://api.github.com/repos/alakarteio/k-simple-state/contents/{+path}","compare_url":"https://api.github.com/repos/alakarteio/k-simple-state/compare/{base}...{head}","merges_url":"https://api.github.com/repos/alakarteio/k-simple-state/merges","archive_url":"https://api.github.com/repos/alakarteio/k-simple-state/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/alakarteio/k-simple-state/downloads","issues_url":"https://api.github.com/repos/alakarteio/k-simple-state/issues{/number}","pulls_url":"https://api.github.com/repos/alakarteio/k-simple-state/pulls{/number}","milestones_url":"https://api.github.com/repos/alakarteio/k-simple-state/milestones{/number}","notifications_url":"https://api.github.com/repos/alakarteio/k-simple-state/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/alakarteio/k-simple-state/labels{/name}","releases_url":"https://api.github.com/repos/alakarteio/k-simple-state/releases{/id}","deployments_url":"https://api.github.com/repos/alakarteio/k-simple-state/deployments","created_at":"2018-01-17T19:50:21Z","updated_at":"2018-02-02T09:22:11Z","pushed_at":"2018-02-05T13:48:22Z","git_url":"git://github.com/alakarteio/k-simple-state.git","ssh_url":"git@github.com:alakarteio/k-simple-state.git","clone_url":"https://github.com/alakarteio/k-simple-state.git","svn_url":"https://github.com/alakarteio/k-simple-state","homepage":"","size":235,"stargazers_count":1,"watchers_count":1,"language":"JavaScript","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":2,"mirror_url":null,"archived":false,"open_issues_count":13,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":2,"open_issues":13,"watchers":1,"default_branch":"master"}},"base":{"label":"alakarteio:master","ref":"master","sha":"d10266b3f9c84dd697d77f6e1c34a8d56c14311b","user":{"login":"alakarteio","id":26111459,"avatar_url":"https://avatars2.githubusercontent.com/u/26111459?v=4","gravatar_id":"","url":"https://api.github.com/users/alakarteio","html_url":"https://github.com/alakarteio","followers_url":"https://api.github.com/users/alakarteio/followers","following_url":"https://api.github.com/users/alakarteio/following{/other_user}","gists_url":"https://api.github.com/users/alakarteio/gists{/gist_id}","starred_url":"https://api.github.com/users/alakarteio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alakarteio/subscriptions","organizations_url":"https://api.github.com/users/alakarteio/orgs","repos_url":"https://api.github.com/users/alakarteio/repos","events_url":"https://api.github.com/users/alakarteio/events{/privacy}","received_events_url":"https://api.github.com/users/alakarteio/received_events","type":"Organization","site_admin":false},"repo":{"id":117885088,"name":"k-simple-state","full_name":"alakarteio/k-simple-state","owner":{"login":"alakarteio","id":26111459,"avatar_url":"https://avatars2.githubusercontent.com/u/26111459?v=4","gravatar_id":"","url":"https://api.github.com/users/alakarteio","html_url":"https://github.com/alakarteio","followers_url":"https://api.github.com/users/alakarteio/followers","following_url":"https://api.github.com/users/alakarteio/following{/other_user}","gists_url":"https://api.github.com/users/alakarteio/gists{/gist_id}","starred_url":"https://api.github.com/users/alakarteio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alakarteio/subscriptions","organizations_url":"https://api.github.com/users/alakarteio/orgs","repos_url":"https://api.github.com/users/alakarteio/repos","events_url":"https://api.github.com/users/alakarteio/events{/privacy}","received_events_url":"https://api.github.com/users/alakarteio/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/alakarteio/k-simple-state","description":"State manager for you components apps, the safe and easy way.","fork":false,"url":"https://api.github.com/repos/alakarteio/k-simple-state","forks_url":"https://api.github.com/repos/alakarteio/k-simple-state/forks","keys_url":"https://api.github.com/repos/alakarteio/k-simple-state/keys{/key_id}","collaborators_url":"https://api.github.com/repos/alakarteio/k-simple-state/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/alakarteio/k-simple-state/teams","hooks_url":"https://api.github.com/repos/alakarteio/k-simple-state/hooks","issue_events_url":"https://api.github.com/repos/alakarteio/k-simple-state/issues/events{/number}","events_url":"https://api.github.com/repos/alakarteio/k-simple-state/events","assignees_url":"https://api.github.com/repos/alakarteio/k-simple-state/assignees{/user}","branches_url":"https://api.github.com/repos/alakarteio/k-simple-state/branches{/branch}","tags_url":"https://api.github.com/repos/alakarteio/k-simple-state/tags","blobs_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/refs{/sha}","trees_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/trees{/sha}","statuses_url":"https://api.github.com/repos/alakarteio/k-simple-state/statuses/{sha}","languages_url":"https://api.github.com/repos/alakarteio/k-simple-state/languages","stargazers_url":"https://api.github.com/repos/alakarteio/k-simple-state/stargazers","contributors_url":"https://api.github.com/repos/alakarteio/k-simple-state/contributors","subscribers_url":"https://api.github.com/repos/alakarteio/k-simple-state/subscribers","subscription_url":"https://api.github.com/repos/alakarteio/k-simple-state/subscription","commits_url":"https://api.github.com/repos/alakarteio/k-simple-state/commits{/sha}","git_commits_url":"https://api.github.com/repos/alakarteio/k-simple-state/git/commits{/sha}","comments_url":"https://api.github.com/repos/alakarteio/k-simple-state/comments{/number}","issue_comment_url":"https://api.github.com/repos/alakarteio/k-simple-state/issues/comments{/number}","contents_url":"https://api.github.com/repos/alakarteio/k-simple-state/contents/{+path}","compare_url":"https://api.github.com/repos/alakarteio/k-simple-state/compare/{base}...{head}","merges_url":"https://api.github.com/repos/alakarteio/k-simple-state/merges","archive_url":"https://api.github.com/repos/alakarteio/k-simple-state/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/alakarteio/k-simple-state/downloads","issues_url":"https://api.github.com/repos/alakarteio/k-simple-state/issues{/number}","pulls_url":"https://api.github.com/repos/alakarteio/k-simple-state/pulls{/number}","milestones_url":"https://api.github.com/repos/alakarteio/k-simple-state/milestones{/number}","notifications_url":"https://api.github.com/repos/alakarteio/k-simple-state/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/alakarteio/k-simple-state/labels{/name}","releases_url":"https://api.github.com/repos/alakarteio/k-simple-state/releases{/id}","deployments_url":"https://api.github.com/repos/alakarteio/k-simple-state/deployments","created_at":"2018-01-17T19:50:21Z","updated_at":"2018-02-02T09:22:11Z","pushed_at":"2018-02-05T13:48:22Z","git_url":"git://github.com/alakarteio/k-simple-state.git","ssh_url":"git@github.com:alakarteio/k-simple-state.git","clone_url":"https://github.com/alakarteio/k-simple-state.git","svn_url":"https://github.com/alakarteio/k-simple-state","homepage":"","size":235,"stargazers_count":1,"watchers_count":1,"language":"JavaScript","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":2,"mirror_url":null,"archived":false,"open_issues_count":13,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":2,"open_issues":13,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/48"},"html":{"href":"https://github.com/alakarteio/k-simple-state/pull/48"},"issue":{"href":"https://api.github.com/repos/alakarteio/k-simple-state/issues/48"},"comments":{"href":"https://api.github.com/repos/alakarteio/k-simple-state/issues/48/comments"},"review_comments":{"href":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/48/comments"},"review_comment":{"href":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/alakarteio/k-simple-state/pulls/48/commits"},"statuses":{"href":"https://api.github.com/repos/alakarteio/k-simple-state/statuses/c9f65306294a4cfad2867771aa57c81a78710557"}},"author_association":"OWNER"}}
{"actor":{"display_login":"fabienjuif"}}