refactor(initializeNetwork): clarify name (#11)

Change initializeNetwork to
initializeNetworkHelpers

BREAKING CHANGE: change public
function name (initializeNetwork is
now initializeNetworkHelpers)

Author: adrienharnay

README.md

@@ -47,15 +47,15 @@ import {
   reducer,
   connect,
   reset,
-  initializeNetwork,
+  initializeNetworkHelpers,
 } from '@brigad/redux-rest-easy';
 ```
 
 * [createResource](./docs/api/createResource.md) - easily generate then export your actions and selectors from one file
 * [reducer](./docs/api/reducer.md) - plug a single reducer to your state, we handle the rest
 * [connect](./docs/api/connect.md) - connect your components to the state so the magic can happen
 * [reset](./docs/api/reset.md) - reset `redux-rest-easy`'s whole state (you can reset parts of the state with actions generated by `createResource`)
-* [initializeNetwork](./docs/api/initializeNetwork.md) - provide your own network handling functions (optional, fallback to included defaults)
+* [initializeNetworkHelpers](./docs/api/initializeNetworkHelpers.md) - provide your own network handlers (optional, fallback to included defaults)
 
 ## Internals
 

docs/api/initializeNetwork.md renamed to docs/api/initializeNetworkHelpers.md

@@ -1,4 +1,4 @@
-# `initializeNetwork(networkHelpers)`
+# `initializeNetworkHelpers(networkHelpers)`
 
 Overrides the built-in defaults for network handling.
 
@@ -18,7 +18,7 @@ Overrides the built-in defaults for network handling.
 #### Example
 
 ```js
-import { initializeNetwork } from '@brigad/redux-rest-easy';
+import { initializeNetworkHelpers } from '@brigad/redux-rest-easy';
 
 const networkHelpers = {
   // Mandatory if you don't override the others
@@ -77,7 +77,7 @@ const networkHelpers = {
     };
   },
 
-  // Override to change status code / error handling
+  // Override to change status code handling / error handling
   handleStatusCode: response => {
     if (response) {
       if (response.status >= 200 && response.status < 300) {
@@ -112,7 +112,7 @@ const networkHelpers = {
   },
 };
 
-initializeNetwork(networkHelpers);
+initializeNetworkHelpers(networkHelpers);
 ```
 
 #### Tips

src/index.js

@@ -2,4 +2,6 @@ export { default as connect } from './connect';
 export { default as createResource } from './createResource';
 export { default as reducer } from './reducer';
 export { default as reset } from './reset';
-export { default as initializeNetwork } from './initializeNetwork';
+export {
+  default as initializeNetworkHelpers,
+} from './initializeNetworkHelpers';

src/initializeNetwork.js renamed to src/initializeNetworkHelpers.js

@@ -1,7 +1,7 @@
 import { setNetworkHelpers } from './internals/network/networkHelpers';
 
-const initializeNetwork = (helpers) => {
+const initializeNetworkHelpers = (helpers) => {
   setNetworkHelpers(helpers);
 };
 
-export default initializeNetwork;
+export default initializeNetworkHelpers;