release: 1.0.0 (#11)

* Add typescript note to README

* Update published package refs in README

* Add keywords to package config

* Add repository to package config

* Add CI and codecov badges to README

* Bump version to 1.0.0

Author: ianpurvis

README.md

@@ -1,12 +1,15 @@
+[![CI](https://github.com/ianpurvis/jest-ctx/actions/workflows/ci.yml/badge.svg?branch=trunk)](https://github.com/ianpurvis/jest-ctx/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/ianpurvis/jest-ctx/branch/trunk/graph/badge.svg?token=6BGJQKMJEL)](https://codecov.io/gh/ianpurvis/jest-ctx)
+
 # jest-ctx
 
 Pass context to [Jest](https://jestjs.io) hooks and tests.
 
 ## Getting Started
 
-    $ npm i -D github:ianpurvis/jest-ctx.git
+    $ npm i -D jest-ctx
 
-    $ yarn add -D github:ianpurvis/jest-ctx.git
+    $ yarn add -D jest-ctx
 
 `jest-ctx` exports the same module interface as `@jest/globals`, so it is easy
 to drop into your codebase:
@@ -197,6 +200,16 @@ by the usual args for each table row:
 `test.concurrent` and its variations are affected by a known issue with
 `beforeEach` (https://github.com/facebook/jest/issues/7997)
 
+
+### Typescript
+
+Types should work as usual except that hooks and tests can now receive and
+return context:
+
+    beforeAll((): string => '🫐');
+    it('has typed context', (ctx: string) => expect(ctx).toMatch('🫐'));
+
+
 ## License
 
 `jest-ctx` is available as open source under the terms of the [MIT License](LICENSE).

package-lock.json

@@ -1,8 +1,12 @@
 {
   "name": "jest-ctx",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "Pass context to jest hooks and tests",
   "author": "Ian Purvis <ian@purvisresearch.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ianpurvis/jest-ctx.git"
+  },
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -26,5 +30,12 @@
   },
   "peerDependencies": {
     "jest": ">=25.5.0"
-  }
+  },
+  "keywords": [
+    "jest",
+    "context",
+    "test",
+    "testing",
+    "javascript"
+  ]
 }