Simplified usage example in README

Author: mpeyper

README.md

@@ -60,15 +60,15 @@ Using this library, you do not have to concern yourself with how to construct, r
 
 ```js
 // useCounter.js
-import { useState } from 'react'
+import { useState, useCallback } from 'react'
 
-function useCounter(initialCount = 0) {
-  const [count, setCount] = useState(initialCount)
+function useCounter() {
+  const [count, setCount] = useState(0)
 
-  const incrementBy = useCallback((n) => setCount(count + n), [count])
-  const decrementBy = useCallback((n) => setCount(count - n), [count])
+  const increment = useCallback(() => setCount(count + 1), [count])
+  const decrement = useCallback(() => setCount(count - 1), [count])
 
-  return { count, incrementBy, decrementBy }
+  return { count, increment, decrement }
 }
 
 export default useCounter
@@ -81,34 +81,20 @@ import useCounter from './useCounter'
 
 afterEach(cleanup)
 
-test('should create counter', () => {
-  const { result } = renderHook(() => useCounter())
-
-  expect(result.current.count).toBe(0)
-})
-
 test('should increment counter', () => {
   const { result } = renderHook(() => useCounter())
 
-  act(() => result.current.incrementBy(1))
+  act(() => result.current.increment())
 
   expect(result.current.count).toBe(1)
-
-  act(() => result.current.incrementBy(2))
-
-  expect(result.current.count).toBe(3)
 })
 
 test('should decrement counter', () => {
   const { result } = renderHook(() => useCounter())
 
-  act(() => result.current.decrementBy(1))
+  act(() => result.current.decrement())
 
   expect(result.current.count).toBe(-1)
-
-  act(() => result.current.decrementBy(2))
-
-  expect(result.current.count).toBe(-3)
 })
 ```
 

test/customHook.test.js

@@ -2,44 +2,30 @@ import { useState, useCallback } from 'react'
 import { renderHook, cleanup, act } from 'src'
 
 describe('custom hook tests', () => {
-  function useCounter(initialCount = 0) {
-    const [count, setCount] = useState(initialCount)
+  function useCounter() {
+    const [count, setCount] = useState(0)
 
-    const incrementBy = useCallback((n) => setCount(count + n), [count])
-    const decrementBy = useCallback((n) => setCount(count - n), [count])
+    const increment = useCallback(() => setCount(count + 1), [count])
+    const decrement = useCallback(() => setCount(count - 1), [count])
 
-    return { count, incrementBy, decrementBy }
+    return { count, increment, decrement }
   }
 
   afterEach(cleanup)
 
-  test('should create counter', () => {
-    const { result } = renderHook(() => useCounter())
-
-    expect(result.current.count).toBe(0)
-  })
-
   test('should increment counter', () => {
     const { result } = renderHook(() => useCounter())
 
-    act(() => result.current.incrementBy(1))
+    act(() => result.current.increment())
 
     expect(result.current.count).toBe(1)
-
-    act(() => result.current.incrementBy(2))
-
-    expect(result.current.count).toBe(3)
   })
 
   test('should decrement counter', () => {
     const { result } = renderHook(() => useCounter())
 
-    act(() => result.current.decrementBy(1))
+    act(() => result.current.decrement())
 
     expect(result.current.count).toBe(-1)
-
-    act(() => result.current.decrementBy(2))
-
-    expect(result.current.count).toBe(-3)
   })
 })