update deps and switch to yarn (#31)

* update deps and switch to yarn

* update README

* improve changelog

.circleci/config.yml

@@ -22,15 +22,15 @@ jobs:
             # fallback to using the latest cache if no exact match is found
             - v1-dependencies-
 
-      - run: npm install
+      - run: yarn install
 
       - save_cache:
           paths:
             - node_modules
           key: v1-dependencies-{{ checksum "package-lock.json" }}
 
-      - run: npm run build
-      - run: npm run test:coverage
+      - run: yarn build
+      - run: yarn test:coverage
       - coveralls/upload
 
 workflows:

.eslintrc

@@ -6,8 +6,8 @@
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:react/recommended",
-    "prettier/react",
-    "plugin:prettier/recommended"
+    "plugin:prettier/recommended",
+    "prettier/react"
   ],
   "parserOptions": {
     "ecmaFeatures": {

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.1.0
+
+- Updated dev dependencies.
+- Switched from `npm` to `yarn`.
+
 ## 2.0.0
 
 This release is a complete rewrite to support a roving tabindex in a grid. There are a few breaking changes, hence the major version bump. Please see the project README file for how to migrate from version 1.

README.md

@@ -36,7 +36,11 @@ This package has been written using the React Hooks API, so it is only usable wi
 ## Installation
 
 ```bash
-npm install --save react-roving-tabindex
+npm install react-roving-tabindex
+
+# or
+
+yarn add react-roving-tabindex
 ```
 
 This package includes TypeScript typings.
@@ -191,8 +195,3 @@ If you have build errors when building the Storybook locally, you are likely usi
 
 - For beta versions: `npm publish --tag next`.
 - For releases: `npm publish`.
-
-### Issues
-
-- The `@types/styled-components` package is currently downgraded to v4.1.8 because of [this issue](https://github.com/DefinitelyTyped/DefinitelyTyped/issues/33311). This only affects the Storybook build.
-- The React dependencies have not yet been upgraded to version 17 because of [this Storybook issue](https://github.com/storybookjs/storybook/issues/12408). Regardless, this package works with React 17 and the `peerDependencies` semver in `package.json` for `react` and `react-dom` permits React 17.