Fix cod review issues - configuration and list component

Author: Marek Rozmus

.babelrc

@@ -1,16 +1,15 @@
 {
   "presets": [
     [
-      "@babel/preset-env", {
+      "@babel/preset-env",
+      {
         "targets": {
-          "browsers": ["last 2 versions", "safari >= 7"]
+          "browsers": [">0.25%", "not ie 11", "not op_mini all", "safari >= 7"]
         },
         "modules": false
       }
     ],
     "@babel/preset-react"
   ],
-  "plugins": [
-    ["@babel/plugin-proposal-class-properties"]
-  ]
+  "plugins": [["@babel/plugin-proposal-class-properties"]]
 }

.eslintrc

@@ -3,14 +3,20 @@
     "browser": true,
     "node": true
   },
-  "extends": ["plugin:prettier/recommended", "plugin:react/recommended"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:prettier/recommended",
+    "plugin:react/recommended"
+  ],
   "parser": "babel-eslint",
+  "plugins": ["react-hooks"],
   "settings": {
     "react": {
-      "version": "detect"
+      "version": "16.8"
     }
   },
   "rules": {
-    "no-undef": "error"
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn"
   }
 }

.gitignore

@@ -1,3 +1,3 @@
 .DS_Store
-node_modules
+node_modules/
 dist

.prettierrc

@@ -1,4 +1,3 @@
 {
-  "tabWidth": 2,
   "singleQuote": true
 }

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 sandstreamdev
+Copyright 2019 Sandstream Development Sp. z o. o.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,5 +1,28 @@
 # react-swipeable-list
 
+## Installation
+
+```bash
+npm install @sandstreamdev/react-swipeable-list
+# or via yarn
+yarn add @sandstreamdev/react-swipeable-list
+```
+
+## Usage
+
+```javascript jsx
+<SwipeableList>
+  <SwipeableListItem
+    swipeRight={{
+      background: <div>Left background</div>,
+      action: () => console.info('swipe action triggered')
+    }}
+  >
+    <div>Item name</div>
+  </SwipeableListItem>
+</SwipeableList>
+```
+
 ## License
 
 [MIT](LICENSE).